-
Notifications
You must be signed in to change notification settings - Fork 0
/
IronPython.Modules.xml
4510 lines (4425 loc) · 236 KB
/
IronPython.Modules.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
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>IronPython.Modules</name>
</assembly>
<members>
<member name="M:IronPython.Modules.Bz2.Bz2Module.ToArrayNoCopy(System.Collections.Generic.IList{System.Byte})">
<summary>
Try to convert IList(Of byte) to byte[] without copying, if possible.
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="M:IronPython.Modules.Bz2.Bz2Module.BZ2Compressor.GetLatestData">
<summary>
Copy the latest data from the memory buffer.
This won't always contain data, because comrpessed data is only written after a block is filled.
</summary>
<returns></returns>
</member>
<member name="M:IronPython.Modules.Bz2.Bz2Module.BZ2Decompressor.AddData(System.Byte[])">
<summary>
Add data to the input buffer. This manipulates the position of the stream
to make it appear to the BZip2 stream that nothing has actually changed.
</summary>
<param name="bytes">The data to append to the buffer.</param>
</member>
<member name="M:Ionic.BZip2.BitWriter.Reset">
<summary>
Reset the BitWriter.
</summary>
<remarks>
<para>
This is useful when the BitWriter writes into a MemoryStream, and
is used by a BZip2Compressor, which itself is re-used for multiple
distinct data blocks.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BitWriter.WriteBits(System.Int32,System.UInt32)">
<summary>
Write some number of bits from the given value, into the output.
</summary>
<remarks>
<para>
The nbits value should be a max of 25, for safety. For performance
reasons, this method does not check!
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BitWriter.WriteByte(System.Byte)">
<summary>
Write a full 8-bit byte into the output.
</summary>
</member>
<member name="M:Ionic.BZip2.BitWriter.WriteInt(System.UInt32)">
<summary>
Write four 8-bit bytes into the output.
</summary>
</member>
<member name="M:Ionic.BZip2.BitWriter.Flush">
<summary>
Write all available byte-aligned bytes.
</summary>
<remarks>
<para>
This method writes no new output, but flushes any accumulated
bits. At completion, the accumulator may contain up to 7
bits.
</para>
<para>
This is necessary when re-assembling output from N independent
compressors, one for each of N blocks. The output of any
particular compressor will in general have some fragment of a byte
remaining. This fragment needs to be accumulated into the
parent BZip2OutputStream.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BitWriter.FinishAndPad">
<summary>
Writes all available bytes, and emits padding for the final byte as
necessary. This must be the last method invoked on an instance of
BitWriter.
</summary>
</member>
<member name="P:Ionic.BZip2.BitWriter.RemainingBits">
<summary>
Delivers the remaining bits, left-aligned, in a byte.
</summary>
<remarks>
<para>
This is valid only if NumRemainingBits is less than 8;
in other words it is valid only after a call to Flush().
</para>
</remarks>
</member>
<member name="F:Ionic.BZip2.BZip2Compressor.increments">
Knuth's increments seem to work better than Incerpi-Sedgewick here.
Possibly because the number of elems to sort is usually small, typically
<= 20.
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.#ctor(Ionic.BZip2.BitWriter)">
<summary>
BZip2Compressor writes its compressed data out via a BitWriter. This
is necessary because BZip2 does byte shredding.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.Fill(System.Byte[],System.Int32,System.Int32)">
<summary>
Accept new bytes into the compressor data buffer
</summary>
<remarks>
<para>
This method does the first-level (cheap) run-length encoding, and
stores the encoded data into the rle block.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.write0(System.Byte)">
<summary>
Process one input byte into the block.
</summary>
<remarks>
<para>
To "process" the byte means to do the run-length encoding.
There are 3 possible return values:
0 - the byte was not written, in other words, not
encoded into the block. This happens when the
byte b would require the start of a new run, and
the block has no more room for new runs.
1 - the byte was written, and the block is not full.
2 - the byte was written, and the block is full.
</para>
</remarks>
<returns>0 if the byte was not written, non-zero if written.</returns>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.AddRunToOutputBlock(System.Boolean)">
<summary>
Append one run to the output block.
</summary>
<remarks>
<para>
This compressor does run-length-encoding before BWT and etc. This
method simply appends a run to the output block. The append always
succeeds. The return value indicates whether the block is full:
false (not full) implies that at least one additional run could be
processed.
</para>
</remarks>
<returns>true if the block is now full; otherwise false.</returns>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.CompressAndWrite">
<summary>
Compress the data that has been placed (Run-length-encoded) into the
block. The compressed data goes into the CompressedBytes array.
</summary>
<remarks>
<para>
Side effects: 1. fills the CompressedBytes array. 2. sets the
AvailableBytesOut property.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.mainSimpleSort(Ionic.BZip2.BZip2Compressor.CompressionState,System.Int32,System.Int32,System.Int32)">
This is the most hammered method of this class.
<p>
This is the version using unrolled loops.
</p>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.mainQSort3(Ionic.BZip2.BZip2Compressor.CompressionState,System.Int32,System.Int32,System.Int32)">
Method "mainQSort3", file "blocksort.c", BZip2 1.0.2
</member>
<member name="P:Ionic.BZip2.BZip2Compressor.UncompressedBytes">
<summary>
The number of uncompressed bytes being held in the buffer.
</summary>
<remarks>
<para>
I am thinking this may be useful in a Stream that uses this
compressor class. In the Close() method on the stream it could
check this value to see if anything has been written at all. You
may think the stream could easily track the number of bytes it
wrote, which would eliminate the need for this. But, there is the
case where the stream writes a complete block, and it is full, and
then writes no more. In that case the stream may want to check.
</para>
</remarks>
</member>
<member name="F:Ionic.BZip2.BZip2Compressor.CompressionState.quadrant">
Array instance identical to sfmap, both are used only
temporarily and independently, so we do not need to allocate
additional memory.
</member>
<member name="T:Ionic.BZip2.BZip2InputStream">
<summary>
A read-only decorator stream that performs BZip2 decompression on Read.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.#ctor(System.IO.Stream)">
<summary>
Create a BZip2InputStream, wrapping it around the given input Stream.
</summary>
<remarks>
<para>
The input stream will be closed when the BZip2InputStream is closed.
</para>
</remarks>
<param name='input'>The stream from which to read compressed data</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Create a BZip2InputStream with the given stream, and
specifying whether to leave the wrapped stream open when
the BZip2InputStream is closed.
</summary>
<param name='input'>The stream from which to read compressed data</param>
<param name='leaveOpen'>
Whether to leave the input stream open, when the BZip2InputStream closes.
</param>
<example>
This example reads a bzip2-compressed file, decompresses it,
and writes the decompressed data into a newly created file.
<code>
var fname = "logfile.log.bz2";
using (var fs = File.OpenRead(fname))
{
using (var decompressor = new Ionic.BZip2.BZip2InputStream(fs))
{
var outFname = fname + ".decompressed";
using (var output = File.Create(outFname))
{
byte[] buffer = new byte[2048];
int n;
while ((n = decompressor.Read(buffer, 0, buffer.Length)) > 0)
{
output.Write(buffer, 0, n);
}
}
}
}
</code>
</example>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read data from the stream.
</summary>
<remarks>
<para>
To decompress a BZip2 data stream, create a <c>BZip2InputStream</c>,
providing a stream that reads compressed data. Then call Read() on
that <c>BZip2InputStream</c>, and the data read will be decompressed
as you read.
</para>
<para>
A <c>BZip2InputStream</c> can be used only for <c>Read()</c>, not for <c>Write()</c>.
</para>
</remarks>
<param name="buffer">The buffer into which the read data should be placed.</param>
<param name="offset">the offset within that data array to put the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.ReadByte">
<summary>
Read a single byte from the stream.
</summary>
<returns>the byte read from the stream, or -1 if EOF</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">this is irrelevant, since it will always throw!</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="buffer">this parameter is never used</param>
<param name="offset">this parameter is never used</param>
<param name="count">this parameter is never used</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<param name="disposing">
indicates whether the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Close">
<summary>
Close the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.GetBits(System.Int32)">
<summary>
Read n bits from input, right justifying the result.
</summary>
<remarks>
<para>
For example, if you read 1 bit, the result is either 0
or 1.
</para>
</remarks>
<param name ="n">
The number of bits to read, always between 1 and 32.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.hbCreateDecodeTables(System.Int32[],System.Int32[],System.Int32[],System.Char[],System.Int32,System.Int32,System.Int32)">
Called by createHuffmanDecodingTables() exclusively.
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.createHuffmanDecodingTables(System.Int32,System.Int32)">
Called by recvDecodingTables() exclusively.
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.DumpState">
<summary>
Dump the current state of the decompressor, to restore it in case of an error.
This allows the decompressor to be essentially "rewound" and retried when more
data arrives.
This is only used by IronPython.
</summary>
<returns>The current state.</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.RestoreState(System.Object)">
<summary>
Restore the internal compressor state if an error occurred.
</summary>
<param name="o">The old state.</param>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value depends on whether the captive stream supports reading.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the
total number of uncompressed bytes read in.
</remarks>
</member>
<member name="T:Ionic.BZip2.BZip2InputStream.CState">
<summary>
Compressor State
</summary>
</member>
<member name="F:Ionic.BZip2.BZip2InputStream.DecompressionState.unzftab">
Freq table collected to save a pass over the data during
decompression.
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.DecompressionState.initTT(System.Int32)">
Initializes the tt array.
This method is called when the required length of the array is known.
I don't initialize it at construction time to avoid unneccessary
memory allocation when compressing small files.
</member>
<member name="T:Ionic.BZip2.BZip2OutputStream">
<summary>
A write-only decorator stream that compresses data as it is
written using the BZip2 algorithm.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream)">
<summary>
Constructs a new <c>BZip2OutputStream</c>, that sends its
compressed output to the given output stream.
</summary>
<param name='output'>
The destination stream, to which compressed output will be sent.
</param>
<example>
This example reads a file, then compresses it with bzip2 file,
and writes the compressed data into a newly created file.
<code>
var fname = "logfile.log";
using (var fs = File.OpenRead(fname))
{
var outFname = fname + ".bz2";
using (var output = File.Create(outFname))
{
using (var compressor = new Ionic.BZip2.BZip2OutputStream(output))
{
byte[] buffer = new byte[2048];
int n;
while ((n = fs.Read(buffer, 0, buffer.Length)) > 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
</example>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Constructs a new <c>BZip2OutputStream</c> with specified blocksize.
</summary>
<param name = "output">the destination stream.</param>
<param name = "blockSize">
The blockSize in units of 100000 bytes.
The valid range is 1..9.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Constructs a new <c>BZip2OutputStream</c>.
</summary>
<param name = "output">the destination stream.</param>
<param name = "leaveOpen">
whether to leave the captive stream open upon closing this stream.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32,System.Boolean)">
<summary>
Constructs a new <c>BZip2OutputStream</c> with specified blocksize,
and explicitly specifies whether to leave the wrapped stream open.
</summary>
<param name = "output">the destination stream.</param>
<param name = "blockSize">
The blockSize in units of 100000 bytes.
The valid range is 1..9.
</param>
<param name = "leaveOpen">
whether to leave the captive stream open upon closing this stream.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Close">
<summary>
Close the stream.
</summary>
<remarks>
<para>
This may or may not close the underlying stream. Check the
constructors that accept a bool value.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
Use the <c>BZip2OutputStream</c> to compress data while writing:
create a <c>BZip2OutputStream</c> with a writable output stream.
Then call <c>Write()</c> on that <c>BZip2OutputStream</c>, providing
uncompressed data as input. The data sent to the output stream will
be the compressed form of the input data.
</para>
<para>
A <c>BZip2OutputStream</c> can be used only for <c>Write()</c> not for <c>Read()</c>.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">this is irrelevant, since it will always throw!</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="buffer">this parameter is never used</param>
<param name="offset">this parameter is never used</param>
<param name="count">this parameter is never used</param>
<returns>never returns anything; always throws</returns>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.BlockSize">
<summary>
The blocksize parameter specified at construction time.
</summary>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value is always false.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value should always be true, unless and until the
object is disposed and closed.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the
total number of uncompressed bytes written through.
</remarks>
</member>
<member name="T:Ionic.Crc.CRC32">
<summary>
Computes a CRC-32. The CRC-32 algorithm is parameterized - you
can set the polynomial and enable or disable bit
reversal. This can be used for GZIP, BZip2, or ZIP.
</summary>
<remarks>
This type is used internally by DotNetZip; it is generally not used
directly by applications wishing to create, read, or manipulate zip
archive files.
</remarks>
</member>
<member name="M:Ionic.Crc.CRC32.GetCrc32(System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:Ionic.Crc.CRC32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream, and writes the input into the
output stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<param name="output">The stream into which to deflate the input</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:Ionic.Crc.CRC32.ComputeCrc32(System.Int32,System.Byte)">
<summary>
Get the CRC32 for the given (word,byte) combo. This is a
computation defined by PKzip for PKZIP 2.0 (weak) encryption.
</summary>
<param name="W">The word to start with.</param>
<param name="B">The byte to combine it with.</param>
<returns>The CRC-ized result.</returns>
</member>
<member name="M:Ionic.Crc.CRC32.SlurpBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Update the value for the running CRC32 using the given block of bytes.
This is useful when using the CRC32() class in a Stream.
</summary>
<param name="block">block of bytes to slurp</param>
<param name="offset">starting point in the block</param>
<param name="count">how many bytes within the block to slurp</param>
</member>
<member name="M:Ionic.Crc.CRC32.UpdateCRC(System.Byte)">
<summary>
Process one byte in the CRC.
</summary>
<param name = "b">the byte to include into the CRC . </param>
</member>
<member name="M:Ionic.Crc.CRC32.UpdateCRC(System.Byte,System.Int32)">
<summary>
Process a run of N identical bytes into the CRC.
</summary>
<remarks>
<para>
This method serves as an optimization for updating the CRC when a
run of identical bytes is found. Rather than passing in a buffer of
length n, containing all identical bytes b, this method accepts the
byte value and the length of the (virtual) buffer - the length of
the run.
</para>
</remarks>
<param name = "b">the byte to include into the CRC. </param>
<param name = "n">the number of times that byte should be repeated. </param>
</member>
<member name="M:Ionic.Crc.CRC32.Combine(System.Int32,System.Int32)">
<summary>
Combines the given CRC32 value with the current running total.
</summary>
<remarks>
This is useful when using a divide-and-conquer approach to
calculating a CRC. Multiple threads can each calculate a
CRC32 on a segment of the data, and then combine the
individual CRC32 values at the end.
</remarks>
<param name="crc">the crc value to be combined with this one</param>
<param name="length">the length of data the CRC value was calculated on</param>
</member>
<member name="M:Ionic.Crc.CRC32.#ctor">
<summary>
Create an instance of the CRC32 class using the default settings: no
bit reversal, and a polynomial of 0xEDB88320.
</summary>
</member>
<member name="M:Ionic.Crc.CRC32.#ctor(System.Boolean)">
<summary>
Create an instance of the CRC32 class, specifying whether to reverse
data bits or not.
</summary>
<param name='reverseBits'>
specify true if the instance should reverse data bits.
</param>
<remarks>
<para>
In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
want a CRC32 with compatibility with BZip2, you should pass true
here. In the CRC-32 used by GZIP and PKZIP, the bits are not
reversed; Therefore if you want a CRC32 with compatibility with
those, you should pass false.
</para>
</remarks>
</member>
<member name="M:Ionic.Crc.CRC32.#ctor(System.Int32,System.Boolean)">
<summary>
Create an instance of the CRC32 class, specifying the polynomial and
whether to reverse data bits or not.
</summary>
<param name='polynomial'>
The polynomial to use for the CRC, expressed in the reversed (LSB)
format: the highest ordered bit in the polynomial value is the
coefficient of the 0th power; the second-highest order bit is the
coefficient of the 1 power, and so on. Expressed this way, the
polynomial for the CRC-32C used in IEEE 802.3, is 0xEDB88320.
</param>
<param name='reverseBits'>
specify true if the instance should reverse data bits.
</param>
<remarks>
<para>
In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
want a CRC32 with compatibility with BZip2, you should pass true
here for the <c>reverseBits</c> parameter. In the CRC-32 used by
GZIP and PKZIP, the bits are not reversed; Therefore if you want a
CRC32 with compatibility with those, you should pass false for the
<c>reverseBits</c> parameter.
</para>
</remarks>
</member>
<member name="M:Ionic.Crc.CRC32.Reset">
<summary>
Reset the CRC-32 class - clear the CRC "remainder register."
</summary>
<remarks>
<para>
Use this when employing a single instance of this class to compute
multiple, distinct CRCs on multiple, distinct data blocks.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CRC32.TotalBytesRead">
<summary>
Indicates the total number of bytes applied to the CRC.
</summary>
</member>
<member name="P:Ionic.Crc.CRC32.Crc32Result">
<summary>
Indicates the current CRC for all blocks slurped in.
</summary>
</member>
<member name="T:Ionic.Crc.CrcCalculatorStream">
<summary>
A Stream that calculates a CRC32 (a checksum) on all bytes read,
or on all bytes written.
</summary>
<remarks>
<para>
This class can be used to verify the CRC of a ZipEntry when
reading from a stream, or to calculate a CRC when writing to a
stream. The stream should be used to either read, or write, but
not both. If you intermix reads and writes, the results are not
defined.
</para>
<para>
This class is intended primarily for use internally by the
DotNetZip library.
</para>
</remarks>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream)">
<summary>
The default constructor.
</summary>
<remarks>
<para>
Instances returned from this constructor will leave the underlying
stream open upon Close(). The stream uses the default CRC32
algorithm, which implies a polynomial of 0xEDB88320.
</para>
</remarks>
<param name="stream">The underlying stream</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
The constructor allows the caller to specify how to handle the
underlying stream at close.
</summary>
<remarks>
<para>
The stream uses the default CRC32 algorithm, which implies a
polynomial of 0xEDB88320.
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="leaveOpen">true to leave the underlying stream
open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64)">
<summary>
A constructor allowing the specification of the length of the stream
to read.
</summary>
<remarks>
<para>
The stream uses the default CRC32 algorithm, which implies a
polynomial of 0xEDB88320.
</para>
<para>
Instances returned from this constructor will leave the underlying
stream open upon Close().
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean)">
<summary>
A constructor allowing the specification of the length of the stream
to read, as well as whether to keep the underlying stream open upon
Close().
</summary>
<remarks>
<para>
The stream uses the default CRC32 algorithm, which implies a
polynomial of 0xEDB88320.
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
<param name="leaveOpen">true to leave the underlying stream
open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean,Ionic.Crc.CRC32)">
<summary>
A constructor allowing the specification of the length of the stream
to read, as well as whether to keep the underlying stream open upon
Close(), and the CRC32 instance to use.
</summary>
<remarks>
<para>
The stream uses the specified CRC32 instance, which allows the
application to specify how the CRC gets calculated.
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
<param name="leaveOpen">true to leave the underlying stream
open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
<param name="crc32">the CRC32 instance to use to calculate the CRC32</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read from the stream
</summary>
<param name="buffer">the buffer to read</param>
<param name="offset">the offset at which to start</param>
<param name="count">the number of bytes to read</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write to the stream.
</summary>
<param name="buffer">the buffer from which to write</param>
<param name="offset">the offset at which to start writing</param>
<param name="count">the number of bytes to write</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Seeking is not supported on this stream. This method always throws
<see cref="T:System.NotSupportedException"/>
</summary>
<param name="offset">N/A</param>
<param name="origin">N/A</param>
<returns>N/A</returns>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.SetLength(System.Int64)">
<summary>
This method always throws
<see cref="T:System.NotSupportedException"/>
</summary>
<param name="value">N/A</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Close">
<summary>
Closes the stream.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.TotalBytesSlurped">
<summary>
Gets the total number of bytes run through the CRC32 calculator.
</summary>
<remarks>
This is either the total number of bytes read, or the total number of
bytes written, depending on the direction of this stream.
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.Crc">
<summary>
Provides the current CRC for all blocks slurped in.
</summary>
<remarks>
<para>
The running total of the CRC is kept as data is written or read
through the stream. read this property after all reads or writes to
get an accurate CRC for the entire stream.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.LeaveOpen">
<summary>
Indicates whether the underlying stream will be left open when the
<c>CrcCalculatorStream</c> is Closed.
</summary>
<remarks>
<para>
Set this at any point before calling <see cref="M:Ionic.Crc.CrcCalculatorStream.Close"/>.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.CanRead">
<summary>
Indicates whether the stream supports reading.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.CanSeek">
<summary>
Indicates whether the stream supports seeking.
</summary>
<remarks>
<para>
Always returns false.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.CanWrite">
<summary>
Indicates whether the stream supports writing.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.Length">
<summary>
Returns the length of the underlying stream.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.Position">
<summary>
The getter for this property returns the total bytes read.
If you use the setter, it will throw
<see cref="T:System.NotSupportedException"/>.
</summary>
</member>
<member name="T:Ionic.BZip2.ParallelBZip2OutputStream">
<summary>
A write-only decorator stream that compresses data as it is
written using the BZip2 algorithm. This stream compresses by
block using multiple threads.
</summary>
<para>
This class performs BZIP2 compression through writing. For
more information on the BZIP2 algorithm, see
<see href="http://en.wikipedia.org/wiki/BZIP2"/>.
</para>
<para>
This class is similar to <see cref="T:Ionic.BZip2.BZip2OutputStream"/>,
except that this implementation uses an approach that employs multiple
worker threads to perform the compression. On a multi-cpu or multi-core
computer, the performance of this class can be significantly higher than
the single-threaded BZip2OutputStream, particularly for larger streams.
How large? Anything over 10mb is a good candidate for parallel
compression.
</para>
<para>
The tradeoff is that this class uses more memory and more CPU than the
vanilla <c>BZip2OutputStream</c>. Also, for small files, the
<c>ParallelBZip2OutputStream</c> can be much slower than the vanilla
<c>BZip2OutputStream</c>, because of the overhead associated to using the
thread pool.
</para>
<seealso cref="T:Ionic.BZip2.BZip2OutputStream"/>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream)">
<summary>
Constructs a new <c>ParallelBZip2OutputStream</c>, that sends its
compressed output to the given output stream.
</summary>