-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathBrotliEncoder.xml
292 lines (287 loc) · 20 KB
/
BrotliEncoder.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<Type Name="BrotliEncoder" FullName="System.IO.Compression.BrotliEncoder">
<TypeSignature Language="C#" Value="public struct BrotliEncoder : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit BrotliEncoder extends System.ValueType implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.IO.Compression.BrotliEncoder" />
<TypeSignature Language="VB.NET" Value="Public Structure BrotliEncoder
Implements IDisposable" />
<TypeSignature Language="C++ CLI" Value="public value class BrotliEncoder : IDisposable" />
<TypeSignature Language="F#" Value="type BrotliEncoder = struct
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.Brotli" ToVersion="5.0.0.0" FrameworkAlternate="net-5.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides methods and static methods to encode and decode data in a streamless, non-allocating, and performant manner using the Brotli data format specification.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BrotliEncoder (int quality, int window);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 quality, int32 window) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.#ctor(System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (quality As Integer, window As Integer)" />
<MemberSignature Language="C++ CLI" Value="public:
 BrotliEncoder(int quality, int window);" />
<MemberSignature Language="F#" Value="new System.IO.Compression.BrotliEncoder : int * int -> System.IO.Compression.BrotliEncoder" Usage="new System.IO.Compression.BrotliEncoder (quality, window)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="quality" Type="System.Int32" />
<Parameter Name="window" Type="System.Int32" />
</Parameters>
<Docs>
<param name="quality">A number representing quality of the Brotli compression. 0 is the minimum (no compression), 11 is the maximum.</param>
<param name="window">A number representing the encoder window bits. The minimum value is 10, and the maximum value is 24.</param>
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliEncoder" /> structure using the specified quality and window.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="quality" /> is not between the minimum value of 0 and the maximum value of 11.
-or-
<paramref name="window" /> is not between the minimum value of 10 and the maximum value of 24.
</exception>
<exception cref="T:System.IO.IOException">Failed to create the <see cref="T:System.IO.Compression.BrotliEncoder" /> instance.</exception>
</Docs>
</Member>
<Member MemberName="Compress">
<MemberSignature Language="C#" Value="public System.Buffers.OperationStatus Compress (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesConsumed, out int bytesWritten, bool isFinalBlock);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Buffers.OperationStatus Compress(valuetype System.ReadOnlySpan`1<unsigned int8> source, valuetype System.Span`1<unsigned int8> destination, [out] int32& bytesConsumed, [out] int32& bytesWritten, bool isFinalBlock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.Compress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function Compress (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesConsumed As Integer, ByRef bytesWritten As Integer, isFinalBlock As Boolean) As OperationStatus" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Buffers::OperationStatus Compress(ReadOnlySpan<System::Byte> source, Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesConsumed, [Runtime::InteropServices::Out] int % bytesWritten, bool isFinalBlock);" />
<MemberSignature Language="F#" Value="member this.Compress : ReadOnlySpan<byte> * Span<byte> * int * int * bool -> System.Buffers.OperationStatus" Usage="brotliEncoder.Compress (source, destination, bytesConsumed, bytesWritten, isFinalBlock)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Buffers.OperationStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="destination" Type="System.Span<System.Byte>" />
<Parameter Name="bytesConsumed" Type="System.Int32" RefType="out" />
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
<Parameter Name="isFinalBlock" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="source">A read-only span of bytes containing the source data to compress.</param>
<param name="destination">When this method returns, a byte span where the compressed is stored.</param>
<param name="bytesConsumed">When this method returns, the total number of bytes that were read from <paramref name="source" />.</param>
<param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
<param name="isFinalBlock">
<see langword="true" /> to finalize the internal stream, which prevents adding more input data when this method returns; <see langword="false" /> to allow the encoder to postpone the production of output until it has processed enough input.</param>
<summary>Compresses a read-only byte span into a destination span.</summary>
<returns>One of the enumeration values that describes the status with which the span-based operation finished.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Dispose();" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="brotliEncoder.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Frees and disposes unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public System.Buffers.OperationStatus Flush (Span<byte> destination, out int bytesWritten);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Buffers.OperationStatus Flush(valuetype System.Span`1<unsigned int8> destination, [out] int32& bytesWritten) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.Flush(System.Span{System.Byte},System.Int32@)" />
<MemberSignature Language="VB.NET" Value="Public Function Flush (destination As Span(Of Byte), ByRef bytesWritten As Integer) As OperationStatus" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Buffers::OperationStatus Flush(Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten);" />
<MemberSignature Language="F#" Value="member this.Flush : Span<byte> * int -> System.Buffers.OperationStatus" Usage="brotliEncoder.Flush (destination, bytesWritten)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Buffers.OperationStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="destination" Type="System.Span<System.Byte>" />
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
</Parameters>
<Docs>
<param name="destination">When this method returns, a span of bytes where the compressed data will be stored.</param>
<param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
<summary>Compresses an empty read-only span of bytes into its destination, which ensures that output is produced for all the processed input. An actual flush is performed when the source is depleted and there is enough space in the destination for the remaining data.</summary>
<returns>One of the enumeration values that describes the status with which the operation finished.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetMaxCompressedLength">
<MemberSignature Language="C#" Value="public static int GetMaxCompressedLength (int inputSize);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 GetMaxCompressedLength(int32 inputSize) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.GetMaxCompressedLength(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GetMaxCompressedLength (inputSize As Integer) As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 static int GetMaxCompressedLength(int inputSize);" />
<MemberSignature Language="F#" Value="static member GetMaxCompressedLength : int -> int" Usage="System.IO.Compression.BrotliEncoder.GetMaxCompressedLength inputSize" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inputSize" Type="System.Int32" />
</Parameters>
<Docs>
<param name="inputSize">The input size to get the maximum expected compressed length from. Must be greater or equal than 0 and less or equal than <see cref="F:System.Int32.MaxValue" /> - 515.</param>
<summary>Gets the maximum expected compressed length for the provided input size.</summary>
<returns>A number representing the maximum compressed length for the provided input size.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Returns 1 if `inputSize` is 0.
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="inputSize" /> is less than 0, the minimum allowed input size, or greater than <see cref="F:System.Int32.MaxValue" /> - 515, the maximum allowed input size.</exception>
</Docs>
</Member>
<Member MemberName="TryCompress">
<MemberSignature Language="C#" Value="public static bool TryCompress (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesWritten);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryCompress(valuetype System.ReadOnlySpan`1<unsigned int8> source, valuetype System.Span`1<unsigned int8> destination, [out] int32& bytesWritten) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.TryCompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryCompress (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesWritten As Integer) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 static bool TryCompress(ReadOnlySpan<System::Byte> source, Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten);" />
<MemberSignature Language="F#" Value="static member TryCompress : ReadOnlySpan<byte> * Span<byte> * int -> bool" Usage="System.IO.Compression.BrotliEncoder.TryCompress (source, destination, bytesWritten)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="destination" Type="System.Span<System.Byte>" />
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
</Parameters>
<Docs>
<param name="source">A read-only span of bytes containing the source data to compress.</param>
<param name="destination">When this method returns, a span of bytes where the compressed data is stored.</param>
<param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
<summary>Tries to compress a source byte span into a destination span.</summary>
<returns>
<see langword="true" /> if the compression operation was successful; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryCompress">
<MemberSignature Language="C#" Value="public static bool TryCompress (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesWritten, int quality, int window);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryCompress(valuetype System.ReadOnlySpan`1<unsigned int8> source, valuetype System.Span`1<unsigned int8> destination, [out] int32& bytesWritten, int32 quality, int32 window) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliEncoder.TryCompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryCompress (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesWritten As Integer, quality As Integer, window As Integer) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 static bool TryCompress(ReadOnlySpan<System::Byte> source, Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten, int quality, int window);" />
<MemberSignature Language="F#" Value="static member TryCompress : ReadOnlySpan<byte> * Span<byte> * int * int * int -> bool" Usage="System.IO.Compression.BrotliEncoder.TryCompress (source, destination, bytesWritten, quality, window)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Compression.Brotli</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="destination" Type="System.Span<System.Byte>" />
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
<Parameter Name="quality" Type="System.Int32" />
<Parameter Name="window" Type="System.Int32" />
</Parameters>
<Docs>
<param name="source">A read-only span of bytes containing the source data to compress.</param>
<param name="destination">When this method returns, a span of bytes where the compressed data is stored.</param>
<param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
<param name="quality">A number representing quality of the Brotli compression. 0 is the minimum (no compression), 11 is the maximum.</param>
<param name="window">A number representing the encoder window bits. The minimum value is 10, and the maximum value is 24.</param>
<summary>Tries to compress a source byte span into a destination byte span, using the provided compression quality leven and encoder window bits.</summary>
<returns>
<see langword="true" /> if the compression operation was successful; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>