K4os.Compression.LZ4.Streams.xml
15.4 KB
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
293
294
295
296
<?xml version="1.0"?>
<doc>
<assembly>
<name>K4os.Compression.LZ4.Streams</name>
</assembly>
<members>
<member name="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor">
<summary>
LZ4 Frame descriptor.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentLength">
<summary>Content length. Not always known.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentChecksum">
<summary>Indicates if content checksum is provided.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Chaining">
<summary>Indicates if blocks are chained (dependent) or not (independent).</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockChecksum">
<summary>Indicates if block checksums are provided.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Dictionary">
<summary>Dictionary id. May be null.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockSize">
<summary>Block size.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings">
<summary>
Decoder settings.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderSettings.ExtraMemory">
<summary>Extra memory for decompression.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream">
<summary>
LZ4 Decompression stream handling.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.#ctor(System.IO.Stream,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder},System.Boolean)">
<summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
<param name="inner">Inner stream.</param>
<param name="decoderFactory">A function which will create appropriate decoder depending
on frame descriptor.</param>
<param name="leaveOpen">If <c>true</c> inner stream will not be closed after disposing.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Flush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.FlushAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanRead">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanSeek">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanWrite">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Length">
<summary>
Length of stream. Please note, this will only work if original LZ4 stream has
<c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Position">
<summary>
Position within the stream. Position can be read, but cannot be set as LZ4 stream does
not have <c>Seek</c> capability.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanTimeout">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteTimeout">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadTimeout">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.SetLength(System.Int64)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Write(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteByte(System.Byte)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings">
<summary>
LZ4 encoder settings.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentLength">
<summary>
Content length. It is not enforced, it can be set to any value, but it will be
written to the stream so it can be used while decoding. If you don't know the length
just leave default value.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ChainBlocks">
<summary>
Indicates if blocks should be chained (dependent) or not (independent). Dependent blocks
(with chaining) provide better compression ratio but are a little but slower and take
more memory.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockSize">
<summary>
Block size. You can use any block size, but default values for LZ4 are 64k, 256k, 1m,
and 4m. 64k is good enough for dependent blocks, but for independent blocks bigger is
better.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentChecksum">
<summary>Indicates is content checksum is provided. Not implemented yet.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
<summary>Indicates if block checksum is provided. Not implemented yet.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.Dictionary">
<summary>Dictionary id. Not implemented yet.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.CompressionLevel">
<summary>Compression level.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ExtraMemory">
<summary>Extra memory (for the process, more is usually better).</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream">
<summary>
LZ4 compression stream.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.#ctor(System.IO.Stream,K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},System.Boolean)">
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
<param name="inner">Inner stream.</param>
<param name="descriptor">LZ4 Descriptor.</param>
<param name="encoderFactory">Function which will take descriptor and return
appropriate encoder.</param>
<param name="leaveOpen">Indicates if <paramref name="inner"/> stream should be left
open after disposing.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Flush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.FlushAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Close">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteByte(System.Byte)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanSeek">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanWrite">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Length">
<summary>Length of the stream and number of bytes written so far.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Position">
<summary>Read-only position in the stream. Trying to set it will throw
<see cref="T:System.InvalidOperationException"/>.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanTimeout">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadTimeout">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteTimeout">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.SetLength(System.Int64)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadByte">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.LZ4Descriptor">
<summary>
LZ4 frame descriptor.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentLength">
<summary>Content length (if available).</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentChecksum">
<summary>Indicates if content checksum if present.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Chaining">
<summary>Indicates if blocks are chained.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockChecksum">
<summary>Indicates if block checksums are present.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Dictionary">
<summary>Dictionary id (or null).</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockSize">
<summary>Block size.</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(System.Nullable{System.Int64},System.Boolean,System.Boolean,System.Boolean,System.Nullable{System.UInt32},System.Int32)">
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
<param name="contentLength">Content length.</param>
<param name="contentChecksum">Content checksum flag.</param>
<param name="chaining">Chaining flag.</param>
<param name="blockChecksum">Block checksum flag.</param>
<param name="dictionary">Dictionary id.</param>
<param name="blockSize">Block size.</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.LZ4Stream">
<summary>
Utility class with factory methods to create LZ4 compression and decompression streams.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
<summary>Created compression stream on top of inner stream.</summary>
<param name="stream">Inner stream.</param>
<param name="settings">Compression settings.</param>
<param name="leaveOpen">Leave inner stream open after disposing.</param>
<returns>Compression stream.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
<summary>Created compression stream on top of inner stream.</summary>
<param name="stream">Inner stream.</param>
<param name="level">Compression level.</param>
<param name="extraMemory">Extra memory used for compression.</param>
<param name="leaveOpen">Leave inner stream open after disposing.</param>
<returns>Compression stream.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4DecoderSettings,System.Boolean)">
<summary>Creates decompression stream on top of inner stream.</summary>
<param name="stream">Inner stream.</param>
<param name="settings">Decompression settings.</param>
<param name="leaveOpen">Leave inner stream open after disposing.</param>
<returns>Decompression stream.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean)">
<summary>Creates decompression stream on top of inner stream.</summary>
<param name="stream">Inner stream.</param>
<param name="extraMemory">Extra memory used for decompression.</param>
<param name="leaveOpen">Leave inner stream open after disposing.</param>
<returns>Decompression stream.</returns>
</member>
</members>
</doc>