-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathK4os.Compression.LZ4.Streams.xml
More file actions
1630 lines (1629 loc) · 102 KB
/
Copy pathK4os.Compression.LZ4.Streams.xml
File metadata and controls
1630 lines (1629 loc) · 102 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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>K4os.Compression.LZ4.Streams</name>
</assembly>
<members>
<member name="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader">
<summary>
Generic interface for frame/stream decoder for LZ4.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame">
<summary>
Opens frame for reading. Please note, this method is not needed as it will be
called automatically, but it can be used to quickly check if frame is valid.
</summary>
<returns><c>true</c> if frame was just opened,
<c>false</c> if it was opened before.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrameAsync(System.Threading.CancellationToken)">
<summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame"/>.</summary>
<param name="token">Cancellation token.</param>
<returns><c>true</c> if frame was just opened,
<c>false</c> if it was opened before.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength">
<summary>Gets the length of the frame content if it was provided when content was encoded.</summary>
<returns>Frame length, or <c>null</c></returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLengthAsync(System.Threading.CancellationToken)">
<summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength"/>.</summary>
<param name="token">Cancellation token.</param>
<returns>Frame length, or <c>null</c></returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadOneByte">
<summary>Reads one byte from LZ4 stream.</summary>
<returns>A byte, or -1 if end of stream.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadOneByteAsync(System.Threading.CancellationToken)">
<summary>Reads one byte from LZ4 stream.</summary>
<param name="token">Cancellation token.</param>
<returns>A byte, or -1 if end of stream.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadManyBytes(System.Span{System.Byte},System.Boolean)">
<summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
<param name="buffer">Byte buffer to read into.</param>
<param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
if <c>false</c> then waits for all bytes being read or end of stream.</param>
<returns>Number of bytes actually read.
<c>0</c> means that end of stream has been reached.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadManyBytesAsync(System.Threading.CancellationToken,System.Memory{System.Byte},System.Boolean)">
<summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
<param name="token">Cancellation token.</param>
<param name="buffer">Byte buffer to read into.</param>
<param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
if <c>false</c> then waits for all bytes being read or end of stream.</param>
<returns>Number of bytes actually read.
<c>0</c> means that end of stream has been reached.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetBytesRead">
<summary>Returns how many bytes in has been read from stream so far.</summary>
<returns>Number of bytes read in total.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.CloseFrame">
<summary>Closes the stream, releases allocated memory.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter">
<summary>
Generic interface for LZ4 frame/stream writer.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.OpenFrame">
<summary>
Opens a stream by reading frame header. Please note, this methods can be called explicitly
but does not need to be called, it will be called automatically if needed.
</summary>
<returns><c>true</c> if frame has been opened,
or <c>false</c> if it was opened before.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.OpenFrameAsync(System.Threading.CancellationToken)">
<summary>
Opens a stream by reading frame header. Please note, this methods can be called explicitly
but does not need to be called, it will be called automatically if needed.
</summary>
<param name="token">Cancellation token.</param>
<returns><c>true</c> if frame has been opened,
or <c>false</c> if it was opened before.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteOneByte(System.Byte)">
<summary>Writes one byte to stream.</summary>
<param name="value">Byte to be written.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteOneByteAsync(System.Threading.CancellationToken,System.Byte)">
<summary>Writes one byte to stream.</summary>
<param name="token">Cancellation token.</param>
<param name="value">Byte to be written.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteManyBytes(System.ReadOnlySpan{System.Byte})">
<summary>Writes multiple bytes to stream.</summary>
<param name="buffer">Byte buffer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteManyBytesAsync(System.Threading.CancellationToken,System.ReadOnlyMemory{System.Byte})">
<summary>Writes multiple bytes to stream.</summary>
<param name="token">Cancellation token.</param>
<param name="buffer">Byte buffer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.GetBytesWritten">
<summary>Gets number of bytes written.</summary>
<returns>Total number of bytes (before compression).</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.CloseFrame">
<summary>
Closes frame. Frame needs to be closed for stream to by valid, although
this methods does not need to be called explicitly if stream is properly dispose.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.CloseFrameAsync(System.Threading.CancellationToken)">
<summary>
Closes frame. Frame needs to be closed for stream to by valid, although
this methods does not need to be called explicitly if stream is properly dispose.
</summary>
<param name="token">Cancellation token.</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1">
<summary>
Stream reader interface. It is an adapter for all stream-like structures.
</summary>
<typeparam name="TStreamState">Stream state.</typeparam>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1.Read(`0@,System.Byte[],System.Int32,System.Int32)">
<summary>
Reads at-most <paramref name="length"/> bytes from given <paramref name="state"/>.
</summary>
<param name="state">Stream state.</param>
<param name="buffer">Buffer to read bytes into.</param>
<param name="offset">Offset in buffer.</param>
<param name="length">Maximum number of bytes to read.</param>
<returns>Number of bytes actually read.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1.ReadAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<summary>
Reads at-most <paramref name="length"/> bytes from given <paramref name="state"/>.
</summary>
<param name="state">Stream state.</param>
<param name="buffer">Buffer to read bytes into.</param>
<param name="offset">Offset in buffer.</param>
<param name="length">Maximum number of bytes to read.</param>
<param name="token">Cancellation token.</param>
<returns><see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1"/> containing new stream state,
and number of bytes actually read..</returns>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1">
<summary>
Generic stream writer interface.
When implementing custom compression target or decompression source you need to implement
this adapter. Please note, that this adapter can be implemented as <c>class</c> or
<c>readonly struct</c>. If implemented as <c>struct</c> it cannot have mutable state
as it will be lost. Immutable state is allowed but strongly discouraged.
Use <typeparamref name="TStreamState"/> instead.
</summary>
<typeparam name="TStreamState">Mutable part of stream state.</typeparam>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush">
<summary>Indicates that writer can and should flush after frame.
Please note, flushing may have negative performance effect but may also lead to
better interactivity between writer and reader, as reader will get new block
available as soon as possible.</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.Write(`0@,System.Byte[],System.Int32,System.Int32)">
<summary>Writes byte buffer to underlying stream.</summary>
<param name="state">Stream state.</param>
<param name="buffer">Byte buffer.</param>
<param name="offset">Offset within buffer.</param>
<param name="length">Number of bytes.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.WriteAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<summary>Writes byte buffer to underlying stream.</summary>
<param name="state">Stream state.</param>
<param name="buffer">Byte buffer.</param>
<param name="offset">Offset within buffer.</param>
<param name="length">Number of bytes.</param>
<param name="token">Cancellation token.</param>
<returns>New stream state (mutable part).</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.Flush(`0@)">
<summary>Flushes buffers to underlying storage. Called only when <see cref="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush"/></summary>
<param name="state">Stream state.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.FlushAsync(`0,System.Threading.CancellationToken)">
<summary>Flushes buffers to underlying storage. Called only when <see cref="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush"/></summary>
<param name="state">Stream state.</param>
<param name="token">Cancellation token.</param>
<returns>New stream state (mutable part).</returns>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1">
<summary>
Result of async read operation. Returns new state of the stream and number of bytes read.
</summary>
<param name="Stream">New stream state.</param>
<param name="Bytes">Number of bytes read.</param>
<typeparam name="TStreamState">Stream state.</typeparam>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.#ctor(`0,System.Int32)">
<summary>
Result of async read operation. Returns new state of the stream and number of bytes read.
</summary>
<param name="Stream">New stream state.</param>
<param name="Bytes">Number of bytes read.</param>
<typeparam name="TStreamState">Stream state.</typeparam>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.Stream">
<summary>New stream state.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.Bytes">
<summary>Number of bytes read.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult">
<summary>
Helper methods to create <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1"/>
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Abstractions.ReadResult.Create``1(``0,System.Int32)">
<summary>
Creates read result, composed of new stream state and bytes read.
</summary>
<param name="stream">Stream state.</param>
<param name="bytes">Bytes read.</param>
<typeparam name="TStreamState">Stream state.</typeparam>
<returns>Read result.</returns>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1">
<summary>
Stream adapter for any class implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.
It takes actual class, not interface, so it can use struct implementations
of <see cref="T:System.Buffers.IBufferWriter`1"/> for performance reasons.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
<typeparam name="TBufferWriter">Type implementing <see cref="T:System.Buffers.IBufferWriter`1"/></typeparam>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.Write(`0@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.WriteAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.CanFlush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.Flush(`0@)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.FlushAsync(`0,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter">
<summary>
Stream adapter for <see cref="T:System.ReadOnlyMemory`1"/> and <see cref="T:System.Memory`1"/>.
This class implements <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1"/> for <see cref="T:System.Memory`1"/>
but should be used only in some niche situations, as it is not easy to find out
how many bytes has been written, use <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1"/>
instead.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.#ctor(System.ReadOnlyMemory{System.Byte})">
<summary>
</summary>
<param name="memory"></param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.CopyToBuffer(System.Int32,System.Byte[],System.Int32,System.Int32)">
<summary>
Copies bytes from span to buffer. Performs all length checks.
</summary>
<param name="head">Head offset of <see cref="T:System.ReadOnlyMemory`1"/>.</param>
<param name="buffer">Target buffer.</param>
<param name="offset">Offset in target buffer.</param>
<param name="length">Number of bytes to copy.</param>
<returns>Number of bytes actually copied.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.Read(System.Int32@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.ReadAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter">
<summary>
Stream adapter for <see cref="T:System.ReadOnlyMemory`1"/> and <see cref="T:System.Memory`1"/>.
This class implements <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1"/> for <see cref="T:System.Memory`1"/>
but should be used only in some niche situations, as it is not easy to find out
how many bytes has been written, use <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1"/>
instead.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.#ctor(System.Memory{System.Byte})">
<summary>
Initializes a new instance of the <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter"/> class.
</summary>
<param name="memory">Memory buffer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.Write(System.Int32@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.WriteAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.CanFlush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.Flush(System.Int32@)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.FlushAsync(System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter">
<summary>
Naive and simplistic implementation of adapter for <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
It might be improved in many ways I believe, but it gives some starting point.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter.Read(System.Buffers.ReadOnlySequence{System.Byte}@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter.ReadAsync(System.Buffers.ReadOnlySequence{System.Byte},System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter">
<summary>
LZ4 stream reader/writer adapter for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter"/>.
</summary>
<param name="span">Memory span.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Read(System.Int32@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.ReadAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Write(System.Int32@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.WriteAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.CanFlush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Flush(System.Int32@)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.FlushAsync(System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.EmptyState">
<summary>
Empty record equivalent to Unit/Void.
Works as placeholder type used when working with generic interfaces which do require type,
but implementation needs none.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter">
<summary>
Stream adapter for <see cref="T:System.IO.Pipelines.PipeReader"/>.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.#ctor(System.IO.Pipelines.PipeReader)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter"/>.
</summary>
<param name="reader">Pipe reader.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.Read(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.ReadAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter">
<summary>
LZ4 stream adapter for <see cref="T:System.IO.Pipelines.PipeReader"/>.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.#ctor(System.IO.Pipelines.PipeWriter)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter"/>.
</summary>
<param name="writer">Pipe writer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.Write(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.WriteAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.CanFlush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.Flush(K4os.Compression.LZ4.Streams.Adapters.EmptyState@)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.FlushAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter">
<summary>
LZ4 stream reader/writer adapter for <see cref="T:System.IO.Stream"/>.
Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
pubternal - exposed as public but still very likely to change.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.#ctor(System.IO.Stream)">
<summary>
Creates new stream adapter for
</summary>
<param name="stream"></param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Read(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.ReadAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Write(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.WriteAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.CanFlush">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Flush(K4os.Compression.LZ4.Streams.Adapters.EmptyState@)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.FlushAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan">
<summary>
Unsafe version of <see cref="T:System.Span`1"/>. It is unsafe as it stores raw memory pointer
so memory it points to must be pinned. It allows reading and writing straight to
unmanaged memory but must be used carefully.
NOTE: If you don't understand what has been said above - don't use it. Misuse of this
struct may lead to unpredictable errors and memory corruption.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Bytes">
<summary>Pointer to the first byte of the span.</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Length">
<summary>Length of the span in bytes.</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.#ctor(System.Void*,System.Int32)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> from given pointer and length.
</summary>
<param name="bytes">Pointer to the first byte of the span.</param>
<param name="length">Length of the span in bytes.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Create(System.Void*,System.Int32)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> from raw pointer.
</summary>
<param name="bytes">Pointer block of bytes.</param>
<param name="length">Length of the block.</param>
<returns>New <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.</returns>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Span">
<summary>
Converted to <see cref="T:System.Span`1"/>.
</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Extensions">
<summary>
Utility methods for LZ4 streams.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateEncoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.LZ4Level,System.Int32)">
<summary>
Creates <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/>.
</summary>
<param name="descriptor">LZ4 descriptor.</param>
<param name="level">Compression level.</param>
<param name="extraMemory">Additional memory for encoder.</param>
<returns>Encoder.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateEncoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
<summary>
Creates <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> and <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings"/>.
</summary>
<param name="descriptor">LZ4 descriptor.</param>
<param name="settings">Encoder settings.</param>
<returns>Encoder.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDecoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Int32)">
<summary>
Create <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/>.
</summary>
<param name="descriptor">Descriptor.</param>
<param name="extraMemory">Extra memory (may improves speed, but creates memory pressure).</param>
<returns><see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/>.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDecoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Streams.LZ4DecoderSettings)">
<summary>
Create <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> and <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings"/>.
</summary>
<param name="descriptor">Descriptor.</param>
<param name="settings">Settings.</param>
<returns><see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/>.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDescriptor(K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
<summary>
Creates <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> from <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings"/>.
</summary>
<param name="settings">Settings.</param>
<returns>LZ4 Descriptor.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.OpenFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
<summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame"/>.</summary>
<param name="reader">Decoder.</param>
<returns><c>true</c> if frame was just opened,
<c>false</c> if it was opened before.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.GetFrameLengthAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
<summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength"/>.</summary>
<param name="reader">Decoder.</param>
<returns>Frame length, or <c>null</c></returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.ReadOneByteAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
<summary>Reads one byte from LZ4 stream.</summary>
<param name="reader">Decoder.</param>
<returns>A byte, or -1 if end of stream.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.ReadManyBytesAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Memory{System.Byte},System.Boolean)">
<summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
<param name="reader">Decoder.</param>
<param name="buffer">Byte buffer to read into.</param>
<param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
if <c>false</c> then waits for all bytes being read or end of stream.</param>
<returns>Number of bytes actually read.
<c>0</c> means that end of stream has been reached.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.OpenFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter)">
<summary>
Opens a stream by reading frame header. Please note, this methods can be called explicitly
but does not need to be called, it will be called automatically if needed.
</summary>
<param name="writer">Encoder.</param>
<returns><c>true</c> if frame has been opened, or <c>false</c> if it was opened before.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.WriteOneByteAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Byte)">
<summary>Writes one byte to stream.</summary>
<param name="writer">Encoder.</param>
<param name="value">Byte to be written.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.WriteManyBytesAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.ReadOnlyMemory{System.Byte})">
<summary>Writes multiple bytes to stream.</summary>
<param name="writer">Encoder.</param>
<param name="buffer">Byte buffer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CloseFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter)">
<summary>
Closes frame. Frame needs to be closed for stream to by valid, although
this methods does not need to be called explicitly if stream is properly dispose.
</summary>
<param name="writer">Encoder.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyTo``1(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,``0,System.Int32)">
<summary>
Copies all bytes from <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> into <see cref="T:System.Buffers.IBufferWriter`1"/>.
</summary>
<param name="source">Frame reader.</param>
<param name="target">Buffer writer.</param>
<param name="blockSize">Chunk size.</param>
<typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyToAsync``1(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,``0,System.Int32)">
<summary>
Copies all bytes from <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> into <see cref="T:System.Buffers.IBufferWriter`1"/>.
</summary>
<param name="source">LZ4 frame reader.</param>
<param name="target">Buffer writer.</param>
<param name="blockSize">Chunk size.</param>
<typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyFrom(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Buffers.ReadOnlySequence{System.Byte})">
<summary>
Copies all bytes from <see cref="T:System.Buffers.ReadOnlySequence`1"/> into <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/>.
</summary>
<param name="target">Frame writer.</param>
<param name="source">Sequence of bytes.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyFromAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Buffers.ReadOnlySequence{System.Byte})">
<summary>
Copies all bytes from <see cref="T:System.Buffers.ReadOnlySequence`1"/> into <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/>.
</summary>
<param name="target">Frame writer.</param>
<param name="source">Sequence of bytes.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.AsStream(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Boolean,System.Boolean)">
<summary>
Wraps <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> as <see cref="T:System.IO.Stream"/>.
</summary>
<param name="reader">LZ4 frame reader.</param>
<param name="leaveOpen">Indicates that frame reader should be left open even if stream is
disposed.</param>
<param name="interactive">Indicates that data should be provided to reader as quick as
possible, instead of waiting for whole block to be read.</param>
<returns><see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream"/> stream wrapper.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Extensions.AsStream(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Boolean)">
<summary>
Wraps <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> as <see cref="T:System.IO.Stream"/>.
</summary>
<param name="writer">LZ4 frame writer.</param>
<param name="leaveOpen">Indicates that frame writer should be left open even if stream is
disposed.</param>
<returns><see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream"/> stream wrapper.</returns>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2">
<summary>
LZ4 Decompression stream handling.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.#ctor(`0,`1,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
<summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
<param name="reader">Inner stream.</param>
<param name="stream">Inner stream initial state.</param>
<param name="decoderFactory">Decoder factory.</param>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.StreamState">
<summary>
Exposes internal stream state. Existence of this property is a hack,
and it really shouldn't be here but it is needed for relatively low
level operations (like writing directly to unmanaged memory).
Please, do not use it directly, if don't know what you are doing.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.CloseFrame">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.AllocBuffer(System.Int32)">
<summary>Allocate temporary buffer to store decompressed data.</summary>
<param name="size">Minimum size of the buffer.</param>
<returns>Allocated buffer.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseBuffer(System.Byte[])">
<summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.AllocBuffer(System.Int32)"/></summary>
<param name="buffer">Previously allocated buffer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.OpenFrame">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.OpenFrameAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetBytesRead">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetFrameLength">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetFrameLengthAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadOneByte">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadOneByteAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadManyBytes(System.Span{System.Byte},System.Boolean)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadManyBytesAsync(System.Threading.CancellationToken,System.Memory{System.Byte},System.Boolean)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.Dispose(System.Boolean)">
<summary>
Disposes the decoder. Consecutive attempts to read will fail.
</summary>
<param name="disposing"><c>true</c> is stream is being disposed by user,
<c>true</c> is by garbage collector.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseResources">
<summary>
Releases unmanaged resources.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseResourcesAsync">
<summary>
Releases unmanaged resources.
</summary>
<returns>Task indicating operation is finished.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.Dispose">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader"/>.
</summary>
<param name="span">Bytes span.</param>
<param name="decoderFactory">LZ4 decoder factory.</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.ReadOnlyMemory`1"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader.#ctor(System.ReadOnlyMemory{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader"/>.
</summary>
<param name="memory">Memory buffer.</param>
<param name="decoderFactory">LZ4 decoder factory.</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader"/>.
</summary>
<param name="sequence">Byte sequence.</param>
<param name="decoderFactory">LZ4 decoder factory.</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.IO.Stream"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.#ctor(System.IO.Stream,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader"/>.
</summary>
<param name="stream">Stream to read from.</param>
<param name="leaveOpen">Leave stream open after reader is disposed.</param>
<param name="decoderFactory">LZ4 decoder factory.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.Dispose(System.Boolean)">
<summary>
Disposes the reader.
</summary>
<param name="disposing"><c>true</c> if user is disposing it; <c>false</c> if it has been triggered by garbage collector</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.IO.Pipelines.PipeReader"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.#ctor(System.IO.Pipelines.PipeReader,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader"/>.
</summary>
<param name="pipe">Pipe to be read.</param>
<param name="leaveOpen">Leave pipe open after reader is disposed.</param>
<param name="decoderFactory">LZ4 decoder factory.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.ReleaseResources">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.ReleaseResourcesAsync">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream">
<summary>
<see cref="T:System.IO.Stream"/> wrapper for <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.#ctor(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Boolean,System.Boolean)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream"/>.
</summary>
<param name="reader">LZ4 frame reader.</param>
<param name="leaveOpen">Leave underlying stream open after disposing this stream.</param>
<param name="interactive">Use interactive mode; return bytes as soon as they available.</param>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.CanRead">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadByte">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.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>.
It will also require synchronous stream access, so it wont work if AllowSynchronousIO
is <c>false</c>.
</summary>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.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="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2">
<summary>
LZ4 stream encoder.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.#ctor(`0,`1,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
<param name="writer">Inner stream.</param>
<param name="stream">Inner stream initial state.</param>
<param name="encoderFactory">LZ4 Encoder factory.</param>
<param name="descriptor">LZ4 settings.</param>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.StreamState">
<summary>
Exposes internal stream state. Existence of this field is a hack,
and it really shouldn't be here but it is needed for relatively low
level operations (like writing directly to unmanaged memory).
Please, do not use it directly, if don't know what you are doing.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.AllocateBuffer(System.Int32)">
<summary>Allocate temporary buffer to store decompressed data.</summary>
<param name="size">Minimum size of the buffer.</param>
<returns>Allocated buffer.</returns>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseBuffer(System.Byte[])">
<summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.AllocateBuffer(System.Int32)"/></summary>
<param name="buffer">Previously allocated buffer.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.GetBytesWritten">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteOneByte(System.Byte)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteOneByteAsync(System.Threading.CancellationToken,System.Byte)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteManyBytes(System.ReadOnlySpan{System.Byte})">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteManyBytesAsync(System.Threading.CancellationToken,System.ReadOnlyMemory{System.Byte})">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.OpenFrame">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.OpenFrameAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.CloseFrame">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.CloseFrameAsync(System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.Dispose(System.Boolean)">
<summary>
Disposes the stream and releases all resources.
</summary>
<param name="disposing"><c>true</c> if called by user; <c>false</c> when called by garbag collector.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.Dispose">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseResources">
<summary>
Releases all unmanaged resources.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseResourcesAsync">
<summary>
Releases all unmanaged resources.
</summary>
<returns>Task indicating completion of the operation.</returns>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Buffers.IBufferWriter`1"/>
</summary>
<typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1.#ctor(`0,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1"/>.
</summary>
<param name="stream">Buffer writer to write to.</param>
<param name="encoderFactory">Encoder factory.</param>
<param name="descriptor">Frame descriptor.</param>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1.BufferWriter">
<summary>Current state of buffer writer.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Buffers.IBufferWriter`1"/>
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter.#ctor(System.Buffers.IBufferWriter{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter"/>.
</summary>
<param name="stream">Buffer writer to write to.</param>
<param name="encoderFactory">Encoder factory.</param>
<param name="descriptor">Frame descriptor.</param>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Memory`1"/>
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter.#ctor(System.Memory{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter"/>.
</summary>
<param name="memory">Memory block where data will be written.</param>
<param name="encoderFactory">Encoder factory.</param>
<param name="descriptor">Frame descriptor.</param>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter.CompressedLength">
<summary>Number of bytes written to the memory.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
<see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> is a wrapper around <see cref="T:System.Span`1"/> that
can be stored in a field. Please note: it makes it unsafe and address needs to be pinned,
one way or another.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter"/>.
</summary>
<param name="span">Span to write to.</param>
<param name="encoderFactory">Encoder factory.</param>
<param name="descriptor">Frame descriptor.</param>
</member>
<member name="P:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter.CompressedLength">
<summary>Number of bytes written to the memory.</summary>
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.IO.Stream"/>.
</summary>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.#ctor(System.IO.Stream,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
<summary>
Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter"/>.
</summary>
<param name="stream">Stream to write to.</param>
<param name="leaveOpen">Leave stream open after disposing this writer.</param>
<param name="encoderFactory">Encoder factory.</param>
<param name="descriptor">Frame descriptor.</param>
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.ReleaseResources">
<inheritdoc />
</member>
<member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.ReleaseResourcesAsync">
<inheritdoc />
</member>
<member name="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter">
<summary>
<see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.IO.Pipelines.PipeWriter"/>.
</summary>
</member>