-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
BrotliDecoder.xml
158 lines (152 loc) · 10 KB
/
BrotliDecoder.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
<Type Name="BrotliDecoder" FullName="System.IO.Compression.BrotliDecoder">
<TypeSignature Language="C#" Value="public struct BrotliDecoder : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit BrotliDecoder extends System.ValueType implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.IO.Compression.BrotliDecoder" />
<TypeSignature Language="VB.NET" Value="Public Structure BrotliDecoder
Implements IDisposable" />
<TypeSignature Language="C++ CLI" Value="public value class BrotliDecoder : IDisposable" />
<TypeSignature Language="F#" Value="type BrotliDecoder = 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 non-allocating, performant Brotli decompression methods. The methods decompress in a single pass without using a <see cref="T:System.IO.Compression.BrotliStream" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Decompress">
<MemberSignature Language="C#" Value="public System.Buffers.OperationStatus Decompress (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesConsumed, out int bytesWritten);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Buffers.OperationStatus Decompress(valuetype System.ReadOnlySpan`1<unsigned int8> source, valuetype System.Span`1<unsigned int8> destination, [out] int32& bytesConsumed, [out] int32& bytesWritten) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Compression.BrotliDecoder.Decompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@)" />
<MemberSignature Language="VB.NET" Value="Public Function Decompress (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesConsumed As Integer, ByRef bytesWritten As Integer) As OperationStatus" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Buffers::OperationStatus Decompress(ReadOnlySpan<System::Byte> source, Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesConsumed, [Runtime::InteropServices::Out] int % bytesWritten);" />
<MemberSignature Language="F#" Value="member this.Decompress : ReadOnlySpan<byte> * Span<byte> * int * int -> System.Buffers.OperationStatus" Usage="brotliDecoder.Decompress (source, destination, bytesConsumed, 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="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" />
</Parameters>
<Docs>
<param name="source">A buffer containing the compressed data.</param>
<param name="destination">When this method returns, a byte span containing the decompressed data.</param>
<param name="bytesConsumed">The total number of bytes that were read from <paramref name="source" />.</param>
<param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
<summary>Decompresses data that was compressed using the Brotli algorithm.</summary>
<returns>One of the enumeration values that indicates the status of the decompression operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The return value can be as follows:
- <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: `source` was successfully and completely decompressed into `destination`.
- <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType>: There is not enough space in `destination` to decompress `source`.
- <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress.
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The data in `source` is invalid and could not be decompressed.
]]></format>
</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.BrotliDecoder.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="brotliDecoder.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>Releases all resources used by the current Brotli decoder instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryDecompress">
<MemberSignature Language="C#" Value="public static bool TryDecompress (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesWritten);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryDecompress(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.BrotliDecoder.TryDecompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryDecompress (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesWritten As Integer) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 static bool TryDecompress(ReadOnlySpan<System::Byte> source, Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten);" />
<MemberSignature Language="F#" Value="static member TryDecompress : ReadOnlySpan<byte> * Span<byte> * int -> bool" Usage="System.IO.Compression.BrotliDecoder.TryDecompress (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 buffer containing the compressed data.</param>
<param name="destination">When this method returns, a byte span containing the decompressed data.</param>
<param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
<summary>Attempts to decompress data that was compressed with the Brotli algorithm.</summary>
<returns>
<see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If this method returns `false`, `destination` may be empty or contain partially decompressed data, with `bytesWritten` being zero or greater than zero but less than the expected total.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>