/Dlls/Delta.Utilities.Compression.xml
XML | 1414 lines | 1409 code | 5 blank | 0 comment | 0 complexity | 83350cb448db9a3f1304783c8515f541 MD5 | raw file
Large files files are truncated, but you can click here to view the full file
1<?xml version="1.0"?> 2<doc> 3 <assembly> 4 <name>Delta.Utilities.Compression</name> 5 </assembly> 6 <members> 7 <member name="T:Delta.Utilities.Compression.Streams.InflaterInputStream"> 8 <summary> 9 This filter stream is used to decompress data compressed using the 10 "deflate" format. The "deflate" format is described in RFC 1951. 11 This stream may form the basis for other decompression filters. 12 Author of the original java version: John Leuner. 13 </summary> 14 </member> 15 <member name="F:Delta.Utilities.Compression.Streams.InflaterInputStream.inf"> 16 <summary> 17 Decompressor for this stream 18 </summary> 19 </member> 20 <member name="F:Delta.Utilities.Compression.Streams.InflaterInputStream.inputBuffer"> 21 <summary> 22 <see cref="T:Delta.Utilities.Compression.Streams.InflaterInputBuffer">Input buffer</see> for this stream. 23 </summary> 24 </member> 25 <member name="F:Delta.Utilities.Compression.Streams.InflaterInputStream.baseInputStream"> 26 <summary> 27 Base stream the inflater reads from. 28 </summary> 29 </member> 30 <member name="F:Delta.Utilities.Compression.Streams.InflaterInputStream.csize"> 31 <summary> 32 The compressed size 33 </summary> 34 </member> 35 <member name="F:Delta.Utilities.Compression.Streams.InflaterInputStream.isClosed"> 36 <summary> 37 Is closed 38 </summary> 39 <returns>False</returns> 40 </member> 41 <member name="F:Delta.Utilities.Compression.Streams.InflaterInputStream.isStreamOwner"> 42 <summary> 43 Is stream owner 44 </summary> 45 <returns>True</returns> 46 </member> 47 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream)"> 48 <summary> 49 Create an InflaterInputStream with the default decompressor 50 and a default buffer size of 4KB. 51 </summary> 52 <param name = "baseInputStream"> 53 The InputStream to read bytes from 54 </param> 55 </member> 56 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,Delta.Utilities.Compression.Inflaters.Inflater)"> 57 <summary> 58 Create an InflaterInputStream with the specified decompressor 59 and a default buffer size of 4KB. 60 </summary> 61 <param name = "baseInputStream"> 62 The source of input data 63 </param> 64 <param name = "inf"> 65 The decompressor used to decompress data read from baseInputStream 66 </param> 67 </member> 68 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,Delta.Utilities.Compression.Inflaters.Inflater,System.Int32)"> 69 <summary> 70 Create an InflaterInputStream with the specified decompressor 71 and the specified buffer size. 72 </summary> 73 <param name = "baseInputStream"> 74 The InputStream to read bytes from 75 </param> 76 <param name = "inflater"> 77 The decompressor to use 78 </param> 79 <param name = "bufferSize"> 80 Size of the buffer to use 81 </param> 82 </member> 83 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Flush"> 84 <summary> 85 Flushes the baseInputStream 86 </summary> 87 </member> 88 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Seek(System.Int64,System.IO.SeekOrigin)"> 89 <summary> 90 Sets the position within the current stream 91 Always throws a NotSupportedException 92 </summary> 93 <exception cref="T:System.NotSupportedException">Any access</exception> 94 </member> 95 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.SetLength(System.Int64)"> 96 <summary> 97 Set the length of the current stream 98 Always throws a NotSupportedException 99 </summary> 100 <exception cref="T:System.NotSupportedException">Any access</exception> 101 </member> 102 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Write(System.Byte[],System.Int32,System.Int32)"> 103 <summary> 104 Writes a sequence of bytes to stream and advances the current position 105 This method always throws a NotSupportedException 106 </summary> 107 <exception cref="T:System.NotSupportedException">Any access</exception> 108 </member> 109 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.WriteByte(System.Byte)"> 110 <summary> 111 Writes one byte to the current stream and advances the current position 112 Always throws a NotSupportedException 113 </summary> 114 <exception cref="T:System.NotSupportedException">Any access</exception> 115 </member> 116 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"> 117 <summary> 118 Entry point to begin an asynchronous write. 119 Always throws a NotSupportedException. 120 </summary> 121 <param name="buffer">The buffer to write data from</param> 122 <param name="offset">Offset of first byte to write</param> 123 <param name="count">The maximum number of bytes to write</param> 124 <param name="callback">The method to be called when the asynchronous 125 write operation is completed</param> 126 <param name="state">A user-provided object that distinguishes this 127 particular asynchronous write request from other requests</param> 128 <returns>An <see cref="T:System.IAsyncResult">IAsyncResult</see> that 129 references the asynchronous write</returns> 130 <exception cref="T:System.NotSupportedException">Any access</exception> 131 </member> 132 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Close"> 133 <summary> 134 Closes the input stream. When <see cref="P:Delta.Utilities.Compression.Streams.InflaterInputStream.IsStreamOwner"></see> 135 is true the underlying stream is also closed. 136 </summary> 137 </member> 138 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Read(System.Byte[],System.Int32,System.Int32)"> 139 <summary> 140 Decompresses data into the byte array 141 </summary> 142 <param name="buffer">The array to read and decompress data into</param> 143 <param name="offset">The offset indicating where the data should be 144 placed</param> 145 <param name="count">The number of bytes to decompress</param> 146 <returns>The number of bytes read. Zero signals the end of stream 147 </returns> 148 <exception cref="T:Delta.Utilities.Compression.CompressionException">Inflater needs a dictionary 149 </exception> 150 </member> 151 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Skip(System.Int64)"> 152 <summary> 153 Skip specified number of bytes of uncompressed data 154 </summary> 155 <param name="numberOfBytesToSkip">Number of bytes to skip</param> 156 <returns>The number of bytes skipped, zero if the end of stream has 157 been reached.</returns> 158 <exception cref="T:System.ArgumentOutOfRangeException"> 159 Number of bytes to skip is zero or less 160 </exception> 161 </member> 162 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Fill"> 163 <summary> 164 Fills the buffer with more data to decompress. 165 </summary> 166 <exception cref="T:Delta.Utilities.Compression.CompressionException"> 167 Stream ends early 168 </exception> 169 </member> 170 <member name="M:Delta.Utilities.Compression.Streams.InflaterInputStream.StopDecrypting"> 171 <summary> 172 Clear any cryptographic state. 173 </summary> 174 </member> 175 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.IsStreamOwner"> 176 <summary> 177 Get/set flag indicating ownership of underlying stream. 178 When the flag is true <see cref="M:Delta.Utilities.Compression.Streams.InflaterInputStream.Close"/> will close the underlying 179 stream also. 180 </summary> 181 <remarks> 182 The default value is true. 183 </remarks> 184 </member> 185 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.CanRead"> 186 <summary> 187 Gets a value indicating whether the current stream supports reading 188 </summary> 189 </member> 190 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.CanSeek"> 191 <summary> 192 Gets a value of false indicating seeking is not supported for this 193 stream. 194 </summary> 195 </member> 196 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.CanWrite"> 197 <summary> 198 Gets a value of false indicating that this stream is not writeable. 199 </summary> 200 </member> 201 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.Length"> 202 <summary> 203 A value representing the length of the stream in bytes. 204 </summary> 205 </member> 206 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.Position"> 207 <summary> 208 The current position within the stream. 209 Throws a NotSupportedException when attempting to set the position 210 </summary> 211 <exception cref="T:System.NotSupportedException">Attempting to set the position 212 </exception> 213 </member> 214 <member name="P:Delta.Utilities.Compression.Streams.InflaterInputStream.IsEntryAvailable"> 215 <summary> 216 Returns 0 once the end of the stream (EOF) has been reached. 217 Otherwise returns 1. 218 </summary> 219 </member> 220 <member name="T:Delta.Utilities.Compression.CompressionMethod"> 221 <summary> 222 The kind of compression used for an entry in an archive 223 </summary> 224 </member> 225 <member name="F:Delta.Utilities.Compression.CompressionMethod.Stored"> 226 <summary> 227 A direct copy of the file contents is held in the archive. 228 </summary> 229 </member> 230 <member name="F:Delta.Utilities.Compression.CompressionMethod.Deflated"> 231 <summary> 232 Common Zip compression method using a sliding dictionary of up to 233 32KB and secondary compression from Huffman/Shannon-Fano trees. 234 </summary> 235 </member> 236 <member name="T:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree"> 237 <summary> 238 Huffman tree used for inflation 239 </summary> 240 </member> 241 <member name="F:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.MaximumBitLength"> 242 <summary> 243 Maximum bit length 244 </summary> 245 </member> 246 <member name="F:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.defLitLenTree"> 247 <summary> 248 Literal length tree 249 </summary> 250 </member> 251 <member name="F:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.defDistTree"> 252 <summary> 253 Distance tree 254 </summary> 255 </member> 256 <member name="F:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.tree"> 257 <summary> 258 Tree 259 </summary> 260 </member> 261 <member name="M:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.#cctor"> 262 <summary> 263 Create inflater huffman tree 264 </summary> 265 </member> 266 <member name="M:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.#ctor(System.Byte[])"> 267 <summary> 268 Constructs a Huffman tree from the array of code lengths. 269 </summary> 270 <param name = "codeLengths"> 271 the array of code lengths 272 </param> 273 </member> 274 <member name="M:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.GetSymbol(Delta.Utilities.Compression.Streams.StreamManipulator)"> 275 <summary> 276 Reads the next symbol from input. The symbol is encoded using the 277 huffman tree. 278 </summary> 279 <param name="input"> 280 input the input source. 281 </param> 282 <returns> 283 the next symbol, or -1 if not enough input is available. 284 </returns> 285 </member> 286 <member name="M:Delta.Utilities.Compression.Inflaters.InflaterHuffmanTree.BuildTree(System.Byte[])"> 287 <summary> 288 Build tree 289 </summary> 290 <param name="codeLengths">Code lengths</param> 291 </member> 292 <member name="T:Delta.Utilities.Compression.ZipException"> 293 <summary> 294 Represents errors specific to Zip file handling 295 </summary> 296 </member> 297 <member name="T:Delta.Utilities.Compression.CompressionException"> 298 <summary> 299 CompressionException is the base exception class for the SharpZipLibrary. 300 All library exceptions are derived from this. 301 </summary> 302 </member> 303 <member name="M:Delta.Utilities.Compression.CompressionException.#ctor"> 304 <summary> 305 Initializes a new instance of the SharpZipLibraryException class. 306 </summary> 307 </member> 308 <member name="M:Delta.Utilities.Compression.CompressionException.#ctor(System.String)"> 309 <summary> 310 Initializes a new instance of the SharpZipLibraryException class with 311 a specified error message. 312 </summary> 313 </member> 314 <member name="M:Delta.Utilities.Compression.CompressionException.#ctor(System.String,System.Exception)"> 315 <summary> 316 Initializes a new instance of the SharpZipLibraryException class with 317 a specified error message and a reference to the inner exception that 318 is the cause of this exception. 319 </summary> 320 <param name="message">Error message string</param> 321 <param name="innerException">The inner exception</param> 322 </member> 323 <member name="M:Delta.Utilities.Compression.ZipException.#ctor"> 324 <summary> 325 Initializes a new instance of the ZipException class. 326 </summary> 327 </member> 328 <member name="M:Delta.Utilities.Compression.ZipException.#ctor(System.String)"> 329 <summary> 330 Initializes a new instance of the ZipException class with a specified 331 error message. 332 </summary> 333 </member> 334 <member name="T:Delta.Utilities.Compression.Streams.OutputWindow"> 335 <summary> 336 Contains the output from the Inflation process. 337 We need to have a window so that we can refer backwards into the 338 output stream to repeat stuff. 339 </summary> 340 </member> 341 <member name="F:Delta.Utilities.Compression.Streams.OutputWindow.WindowSize"> 342 <summary> 343 Window size 344 </summary> 345 </member> 346 <member name="F:Delta.Utilities.Compression.Streams.OutputWindow.WindowMask"> 347 <summary> 348 Window mask 349 </summary> 350 </member> 351 <member name="F:Delta.Utilities.Compression.Streams.OutputWindow.window"> 352 <summary> 353 The window is 2^15 bytes 354 </summary> 355 <returns>Byte</returns> 356 </member> 357 <member name="F:Delta.Utilities.Compression.Streams.OutputWindow.windowEnd"> 358 <summary> 359 Window end 360 </summary> 361 <returns>0</returns> 362 </member> 363 <member name="F:Delta.Utilities.Compression.Streams.OutputWindow.windowFilled"> 364 <summary> 365 Window filled 366 </summary> 367 <returns>0</returns> 368 </member> 369 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.Write(System.Int32)"> 370 <summary> 371 Write a byte to this output window 372 </summary> 373 <param name="abyte">value to write</param> 374 <exception cref="T:System.InvalidOperationException"> 375 if window is full 376 </exception> 377 </member> 378 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.Repeat(System.Int32,System.Int32)"> 379 <summary> 380 Append a byte pattern already in the window itself 381 </summary> 382 <param name="len">length of pattern to copy</param> 383 <param name="dist">distance from end of window pattern occurs</param> 384 <exception cref="T:System.InvalidOperationException"> 385 If the repeated data overflows the window 386 </exception> 387 </member> 388 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.CopyStored(Delta.Utilities.Compression.Streams.StreamManipulator,System.Int32)"> 389 <summary> 390 Copy from input manipulator to internal window 391 </summary> 392 <param name="input">source of data</param> 393 <param name="len">length of data to copy</param> 394 <returns>the number of bytes copied</returns> 395 </member> 396 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.CopyDict(System.Byte[],System.Int32,System.Int32)"> 397 <summary> 398 Copy dictionary to window 399 </summary> 400 <param name="dict">source dictionary</param> 401 <param name="offset">offset of start in source dictionary</param> 402 <param name="len">length of dictionary</param> 403 <exception cref="T:System.InvalidOperationException"> 404 If window isnt empty 405 </exception> 406 </member> 407 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.GetFreeSpace"> 408 <summary> 409 Get remaining unfilled space in window 410 </summary> 411 <returns>Number of bytes left in window</returns> 412 </member> 413 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.GetAvailable"> 414 <summary> 415 Get bytes available for output in window 416 </summary> 417 <returns>Number of bytes filled</returns> 418 </member> 419 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.CopyOutput(System.Byte[],System.Int32,System.Int32)"> 420 <summary> 421 Copy contents of window to output 422 </summary> 423 <param name="output">buffer to copy to</param> 424 <param name="offset">offset to start at</param> 425 <param name="len">number of bytes to count</param> 426 <returns>The number of bytes copied</returns> 427 <exception cref="T:System.InvalidOperationException"> 428 If a window underflow occurs 429 </exception> 430 </member> 431 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.Reset"> 432 <summary> 433 Reset by clearing window so <see cref="M:Delta.Utilities.Compression.Streams.OutputWindow.GetAvailable">GetAvailable</see> 434 returns 0. 435 </summary> 436 </member> 437 <member name="M:Delta.Utilities.Compression.Streams.OutputWindow.SlowRepeat(System.Int32,System.Int32,System.Int32)"> 438 <summary> 439 Slow repeat 440 </summary> 441 <param name="repStart">Rep start</param> 442 <param name="len">Len</param> 443 <param name="dist">Dist</param> 444 </member> 445 <member name="T:Delta.Utilities.Compression.Inflaters.Inflater"> 446 <summary> 447 Inflater is used to decompress data that has been compressed according 448 to the "deflate" standard described in rfc1950. 449 <para /> 450 The usage is as following. First you have to set some input with 451 <code>setInput()</code>, then inflate() it. If inflate doesn't 452 inflate any bytes there may be three reasons: 453 <ul> 454 <li>needsInput() returns true because the input buffer is empty. 455 You have to provide more input with <code>setInput()</code>. 456 NOTE: needsInput() also returns true when, the stream is finished. 457 </li> 458 <li>needsDictionary() returns true, you have to provide a preset 459 dictionary with <code>setDictionary()</code>.</li> 460 <li>finished() returns true, the inflater has finished.</li> 461 </ul> 462 Once the first output byte is produced, a dictionary will not be 463 needed at a later stage. 464 </summary> 465 </member> 466 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHeaderState"> 467 <summary> 468 These are the possible states for an inflater to perform decoding. 469 </summary> 470 </member> 471 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeDictionaryState"> 472 <summary> 473 These are the possible states for an inflater to perform decoding. 474 </summary> 475 </member> 476 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeBlocksState"> 477 <summary> 478 These are the possible states for an inflater to perform decoding. 479 </summary> 480 </member> 481 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeStoredLength1"> 482 <summary> 483 These are the possible states for an inflater to perform decoding. 484 </summary> 485 </member> 486 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeStoredLength2"> 487 <summary> 488 These are the possible states for an inflater to perform decoding. 489 </summary> 490 </member> 491 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeStored"> 492 <summary> 493 These are the possible states for an inflater to perform decoding. 494 </summary> 495 </member> 496 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeDynamicHeader"> 497 <summary> 498 These are the possible states for an inflater to perform decoding. 499 </summary> 500 </member> 501 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHuffmanState"> 502 <summary> 503 These are the possible states for an inflater to perform decoding. 504 </summary> 505 </member> 506 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHuffmanLengthBits"> 507 <summary> 508 These are the possible states for an inflater to perform decoding. 509 </summary> 510 </member> 511 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHuffmanDistance"> 512 <summary> 513 These are the possible states for an inflater to perform decoding. 514 </summary> 515 </member> 516 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHuffmanDistanceBits"> 517 <summary> 518 These are the possible states for an inflater to perform decoding. 519 </summary> 520 </member> 521 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeChecksum"> 522 <summary> 523 These are the possible states for an inflater to perform decoding. 524 </summary> 525 </member> 526 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.DecodeFinished"> 527 <summary> 528 These are the possible states for an inflater to perform decoding. 529 </summary> 530 </member> 531 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.CopyLengths"> 532 <summary> 533 Copy lengths for literal codes 257..285 534 </summary> 535 </member> 536 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.CopyLengthExtraBits"> 537 <summary> 538 Extra bits for literal codes 257..285 539 </summary> 540 </member> 541 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.CopyDistanceOffsets"> 542 <summary> 543 Copy offsets for distance codes 0..29 544 </summary> 545 </member> 546 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.CopyDistanceExtraBits"> 547 <summary> 548 Extra bits for distance codes 549 </summary> 550 </member> 551 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.mode"> 552 <summary> 553 This variable contains the current state. 554 </summary> 555 </member> 556 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.readAdler"> 557 <summary> 558 The adler checksum of the dictionary or of the decompressed 559 stream, as it is written in the header resp. footer of the 560 compressed stream. 561 Only valid if mode is DecodeDictionaryState or DecodeChecksum. 562 </summary> 563 </member> 564 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.neededBits"> 565 <summary> 566 The number of bits needed to complete the current state. This 567 is valid, if mode is DecodeDictionaryState, DecodeChecksum, 568 DecodeHuffmanLengthBits or DecodeHuffmanDistanceBits. 569 </summary> 570 </member> 571 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.isLastBlock"> 572 <summary> 573 True, if the last block flag was set in the last block of the 574 inflated stream. This means that the stream ends after the 575 current block. 576 </summary> 577 </member> 578 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.totalOut"> 579 <summary> 580 The total number of inflated bytes. 581 </summary> 582 </member> 583 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.totalIn"> 584 <summary> 585 The total number of bytes set with setInput(). This is not the 586 value returned by the TotalIn property, since this also includes the 587 unprocessed input. 588 </summary> 589 </member> 590 <member name="F:Delta.Utilities.Compression.Inflaters.Inflater.noHeader"> 591 <summary> 592 This variable stores the noHeader flag that was given to the 593 constructor. True means, that the inflated stream doesn't contain a 594 Zlib header or footer. 595 </summary> 596 </member> 597 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.#ctor"> 598 <summary> 599 Creates a new inflater or RFC1951 decompressor 600 RFC1950/Zlib headers and footers will be expected in the input data 601 </summary> 602 </member> 603 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.#ctor(System.Boolean)"> 604 <summary> 605 Creates a new inflater. 606 </summary> 607 <param name="noHeader"> 608 True if no RFC1950/Zlib header and footer fields are expected in the 609 input data. This is used for GZIPed/Zipped input. For compatibility 610 with Sun JDK you should provide one byte of input more than needed in 611 this case. 612 </param> 613 </member> 614 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.Reset"> 615 <summary> 616 Resets the inflater so that a new stream can be decompressed. 617 All pending input and output will be discarded. 618 </summary> 619 </member> 620 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHeader"> 621 <summary> 622 Decodes a zlib/RFC1950 header. 623 </summary> 624 <returns>False if more input is needed.</returns> 625 <exception cref="T:Delta.Utilities.Compression.CompressionException">The header is invalid. 626 </exception> 627 </member> 628 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.DecodeDict"> 629 <summary> 630 Decodes the dictionary checksum after the deflate header. 631 </summary> 632 <returns> 633 False if more input is needed. 634 </returns> 635 </member> 636 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.DecodeHuffman"> 637 <summary> 638 Decodes the huffman encoded symbols in the input stream. 639 </summary> 640 <returns> 641 false if more input is needed, true if output window is 642 full or the current block ends. 643 </returns> 644 <exception cref="T:Delta.Utilities.Compression.CompressionException"> 645 if deflated stream is invalid. 646 </exception> 647 </member> 648 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.DecodeChksum"> 649 <summary> 650 Decodes the adler checksum after the deflate stream. 651 </summary> 652 <returns>False if more input is needed.</returns> 653 <exception cref="T:Delta.Utilities.Compression.CompressionException">If checksum doesn't match. 654 </exception> 655 </member> 656 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.Decode"> 657 <summary> 658 Decodes the deflated stream. 659 </summary> 660 <returns>False if more input is needed, or if finished.</returns> 661 <exception cref="T:Delta.Utilities.Compression.CompressionException">If deflated stream is invalid. 662 </exception> 663 </member> 664 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.DecodeLastBlockType(System.Int32)"> 665 <summary> 666 Decode last block type 667 </summary> 668 <param name="type">Type</param> 669 </member> 670 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.SetDictionary(System.Byte[])"> 671 <summary> 672 Sets the preset dictionary. This should only be called, if 673 needsDictionary() returns true and it should set the same 674 dictionary, that was used for deflating. The getAdler() 675 function returns the checksum of the dictionary needed. 676 </summary> 677 <param name="buffer"> 678 The dictionary. 679 </param> 680 </member> 681 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.SetDictionary(System.Byte[],System.Int32,System.Int32)"> 682 <summary> 683 Sets the preset dictionary. This should only be called, if 684 needsDictionary() returns true and it should set the same 685 dictionary, that was used for deflating. The getAdler() 686 function returns the checksum of the dictionary needed. 687 </summary> 688 <param name="buffer">The dictionary.</param> 689 <param name="offset">The offset into buffer where the dictionary 690 starts.</param> 691 <param name="len">The length of the dictionary.</param> 692 <exception cref="T:System.InvalidOperationException"> 693 No dictionary is needed. 694 </exception> 695 <exception cref="T:Delta.Utilities.Compression.CompressionException"> 696 The adler checksum for the buffer is invalid 697 </exception> 698 </member> 699 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.SetInput(System.Byte[])"> 700 <summary> 701 Sets the input. This should only be called, if needsInput() 702 returns true. 703 </summary> 704 <param name="buffer">The input buffer.</param> 705 </member> 706 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.SetInput(System.Byte[],System.Int32,System.Int32)"> 707 <summary> 708 Sets the input. This should only be called, if needsInput() 709 returns true. 710 </summary> 711 <param name="buffer"> 712 The source of input data 713 </param> 714 <param name="offset"> 715 The offset into buffer where the input starts. 716 </param> 717 <param name="length"> 718 The number of bytes of input to use. 719 </param> 720 <exception cref="T:System.InvalidOperationException"> 721 No input is needed. 722 </exception> 723 <exception cref="T:System.ArgumentOutOfRangeException"> 724 The off and/or len are wrong. 725 </exception> 726 </member> 727 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.Inflate(System.Byte[])"> 728 <summary> 729 Inflates the compressed stream to the output buffer. If this 730 returns 0, you should check, whether needsDictionary(), 731 needsInput() or finished() returns true, to determine why no 732 further output is produced. 733 </summary> 734 <param name="buffer">The output buffer.</param> 735 <returns> 736 the number of bytes written to the buffer, 0 if no further 737 output can be produced. 738 </returns> 739 <exception cref="T:System.ArgumentOutOfRangeException"> 740 if buf has length 0. 741 </exception> 742 <exception cref="T:System.FormatException"> 743 if deflated stream is invalid. 744 </exception> 745 </member> 746 <member name="M:Delta.Utilities.Compression.Inflaters.Inflater.Inflate(System.Byte[],System.Int32,System.Int32)"> 747 <summary> 748 Inflates the compressed stream to the output buffer. If this 749 returns 0, you should check, whether needsDictionary(), 750 needsInput() or finished() returns true, to determine why no 751 further output is produced. 752 </summary> 753 <param name="buffer">The output buffer.</param> 754 <param name="offset">The offset into buffer where the output should 755 start.</param> 756 <param name="len">The maximum length of the output.</param> 757 <returns>The number of bytes written to the buffer, 0 if no further 758 output can be produced.</returns> 759 <exception cref="T:System.ArgumentOutOfRangeException"> 760 if len is <= 0. 761 </exception> 762 <exception cref="T:System.ArgumentOutOfRangeException"> 763 if the offset and/or len are wrong. 764 </exception> 765 <exception cref="T:System.FormatException"> 766 if deflated stream is invalid. 767 </exception> 768 </member> 769 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.IsNeedingInput"> 770 <summary> 771 Returns true, if the input buffer is empty. 772 You should then call setInput(). 773 NOTE: This method also returns true when the stream is finished. 774 </summary> 775 </member> 776 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.IsNeedingDictionary"> 777 <summary> 778 Returns true, if a preset dictionary is needed to inflate the input. 779 </summary> 780 </member> 781 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.IsFinished"> 782 <summary> 783 Returns true, if the inflater has finished. This means, that no 784 input is needed and no output can be produced. 785 </summary> 786 </member> 787 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.Adler"> 788 <summary> 789 Gets the adler checksum. This is either the checksum of all 790 uncompressed bytes returned by inflate(), or if needsDictionary() 791 returns true (and thus no output was yet produced) this is the 792 adler checksum of the expected dictionary. 793 </summary> 794 <returns> 795 the adler checksum. 796 </returns> 797 </member> 798 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.TotalOut"> 799 <summary> 800 Gets the total number of output bytes returned by inflate(). 801 </summary> 802 <returns> 803 the total number of output bytes. 804 </returns> 805 </member> 806 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.TotalIn"> 807 <summary> 808 Gets the total number of processed compressed input bytes. 809 </summary> 810 <returns> 811 The total number of bytes of processed input bytes. 812 </returns> 813 </member> 814 <member name="P:Delta.Utilities.Compression.Inflaters.Inflater.RemainingInput"> 815 <summary> 816 Gets the number of unprocessed input bytes. Useful, if the end of the 817 stream is reached and you want to further process the bytes after 818 the deflate stream. 819 </summary> 820 <returns> 821 The number of bytes of the input which have not been processed. 822 </returns> 823 </member> 824 <member name="T:Delta.Utilities.Compression.GeneralBitFlags"> 825 <summary> 826 Defines the contents of the general bit flags field for an archive entry. 827 </summary> 828 </member> 829 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.Encrypted"> 830 <summary> 831 If set indicates that the file is encrypted 832 </summary> 833 </member> 834 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.Method"> 835 <summary> 836 Two bits defining the compression method (only for Method 6 Imploding 837 and 8,9 Deflating) 838 </summary> 839 </member> 840 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.Descriptor"> 841 <summary> 842 If set a trailing data descriptor is appended to the entry data 843 </summary> 844 </member> 845 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.Reserved"> 846 <summary> 847 Reserved 848 </summary> 849 </member> 850 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.Patched"> 851 <summary> 852 If set indicates the file contains Pkzip compressed patched data. 853 </summary> 854 </member> 855 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.StrongEncryption"> 856 <summary> 857 If set strong encryption has been used for this entry. 858 </summary> 859 </member> 860 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.EnhancedCompress"> 861 <summary> 862 Reserved by PKWare for enhanced compression. 863 </summary> 864 </member> 865 <member name="F:Delta.Utilities.Compression.GeneralBitFlags.HeaderMasked"> 866 <summary> 867 If set indicates that values in the local header are masked to hide 868 their actual values. Used when encrypting the central directory 869 contents. 870 </summary> 871 </member> 872 <member name="T:Delta.Utilities.Compression.Checksums.Adler32"> 873 <summary> 874 Computes Adler32 checksum for a stream of data. An Adler32 875 checksum is not as reliable as a CRC32 checksum, but a lot faster to 876 compute. 877 </summary> 878 <remarks> 879 The specification for Adler32 may be found in RFC 1950. 880 ZLIB Compressed Data Format Specification version 3.3) 881 882 From that document: 883 884 "ADLER32 (Adler-32 checksum) 885 This contains a checksum value of the uncompressed data 886 (excluding any dictionary data) computed according to Adler-32 887 algorithm. This algorithm is a 32-bit extension and improvement 888 of the Fletcher algorithm, used in the ITU-T X.224 / ISO 8073 889 standard. 890 891 Adler-32 is composed of two sums accumulated per byte: s1 is 892 the sum of all bytes, s2 is the sum of all s1 values. Both sums 893 are done modulo 65521. s1 is initialized to 1, s2 to zero. The 894 Adler-32 checksum is stored as s2*65536 + s1 in most- 895 significant-byte first (network) order." 896 897 "8.2. The Adler-32 algorithm 898 899 The Adler-32 algorithm is much faster than the CRC32 algorithm yet 900 still provides an extremely low probability of undetected errors. 901 902 The modulo on unsigned long accumulators can be delayed for 5552 903 bytes, so the modulo operation time is negligible. If the bytes 904 are a, b, c, the second sum is 3a + 2b + c + 3, and so is position 905 and order sensitive, unlike the first sum, which is just a 906 checksum. That 65521 is prime is important to avoid a possible 907 large class of two-byte errors that leave the check unchanged. 908 (The Fletcher checksum uses 255, which is not prime and which also 909 makes the Fletcher check insensitive to single byte changes 0 - 910 255.) 911 912 The sum s1 is initialized to 1 instead of zero to make the length 913 of the sequence part of s2, so that the length does not have to be 914 checked separately. (Any sequence of zeroes has a Fletcher 915 checksum of zero.)" 916 </remarks> 917 <see cref="T:Delta.Utilities.Compression.Streams.InflaterInputStream"/> 918 <see cref="T:Delta.Utilities.Compression.Streams.DeflaterOutputStream"/> 919 </member> 920 <member name="F:Delta.Utilities.Compression.Checksums.Adler32.Base"> 921 <summary> 922 largest prime smaller than 65536 923 </summary> 924 </member> 925 <member name="F:Delta.Utilities.Compression.Checksums.Adler32.checksum"> 926 <summary> 927 Checksum 928 </summary> 929 </member> 930 <member name="M:Delta.Utilities.Compression.Checksums.Adler32.#ctor"> 931 <summary> 932 Creates a new instance of the <code>Adler32</code> class. 933 The checksum starts off with a value of 1. 934 </summary> 935 </member> 936 <member name="M:Delta.Utilities.Compression.Checksums.Adler32.Reset"> 937 <summary> 938 Resets the Adler32 checksum to the initial value. 939 </summary> 940 </member> 941 <member name="M:Delta.Utilities.Compression.Checksums.Adler32.Update(System.Int32)"> 942 <summary> 943 Updates the checksum with the byte b. 944 </summary> 945 <param name="value">Data value to add. 946 The high byte of the int is ignored.</param> 947 </member> 948 <member name="M:Delta.Utilities.Compression.Checksums.Adler32.Update(System.Byte[])"> 949 <summary> 950 Updates the checksum with the bytes taken from the array. 951 </summary> 952 <param name="buffer">An array of bytes</param> 953 </member> 954 <member name="M:Delta.Utilities.Compression.Checksums.Adler32.Update(System.Byte[],System.Int32,System.Int32)"> 955 <summary> 956 Updates the checksum with the bytes taken from the array. 957 </summary> 958 <param name="buffer">An array of bytes</param> 959 <param name="offset">Start of the data used for this update</param> 960 <param name="count">Number of bytes to use for this update</param> 961 </member> 962 <member name="P:Delta.Utilities.Compression.Checksums.Adler32.Value"> 963 <summary> 964 Returns the Adler32 data checksum computed so far. 965 </summary> 966 </member> 967 <member name="T:Delta.Utilities.Compression.Checksums.Adler32.Adler32Tests"> 968 <summary> 969 Adler 32 tests 970 </summary> 971 </member> 972 <member name="M:Delta.Utilities.Compression.Checksums.Adler32.Adler32Tests.TestAdler32"> 973 <summary> 974 Test adler 32 975 </summary> 976 </member> 977 <member name="T:Delta.Utilities.Compression.ZipConstants"> 978 <summary> 979 This class contains constants used for Zip format files 980 </summary> 981 </member> 982 <member name="F:Delta.Utilities.Compression.ZipConstants.VersionMadeBy"> 983 <summary> 984 The version made by field for entries in the central header when 985 created by this library 986 </summary> 987 <remarks> 988 This is also the Zip version for the library when comparing against 989 the version required to extract for an entry. See 990 <see cref="P:Delta.Utilities.Compression.Streams.ZipInputStream.CanDecompressEntry"> 991 ZipInputStream.CanDecompressEntry</see>. 992 </remarks> 993 </member> 994 <member name="F:Delta.Utilities.Compression.ZipConstants.VersionStrongEncryption"> 995 <summary> 996 The minimum version required to support strong encryption 997 </summary> 998 </member> 999 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalHeader"> 1000 <summary> 1001 Size of local entry header (excluding variable length fields at end) 1002 </summary> 1003 </member> 1004 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalSignature"> 1005 <summary> 1006 Signature for local entry header 1007 </summary> 1008 </member> 1009 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalVersion"> 1010 <summary> 1011 Offset of version to extract in local entry header 1012 </summary> 1013 </member> 1014 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalFlag"> 1015 <summary> 1016 Offset of general purpose flags in local entry header 1017 </summary> 1018 </member> 1019 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalHow"> 1020 <summary> 1021 Offset of compression method in local entry header 1022 </summary> 1023 </member> 1024 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalTime"> 1025 <summary> 1026 Offset of last mod file time + date in local entry header 1027 </summary> 1028 </member> 1029 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalCrc"> 1030 <summary> 1031 Offset of crc-32 in local entry header 1032 </summary> 1033 </member> 1034 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalSize"> 1035 <summary> 1036 Offset of compressed size in local entry header 1037 </summary> 1038 </member> 1039 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalLength"> 1040 <summary> 1041 Offset of uncompressed size in local entry header 1042 </summary> 1043 </member> 1044 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalName"> 1045 <summary> 1046 Offset of file name length in local entry header 1047 </summary> 1048 </member> 1049 <member name="F:Delta.Utilities.Compression.ZipConstants.LocalExtension"> 1050 <summary> 1051 Offset of extra field length in local entry header 1052 </summary> 1053 </member> 1054 <member name="F:Delta.Utilities.Compression.ZipConstants.SpanningSig"> 1055 <summary> 1056 Signature for spanning entry 1057 </summary> 1058 </member> 1059 <member name="F:Delta.Utilities.Compression.ZipConstants.SpanningTempSig"> 1060 <summary> 1061 Signature for temporary spanning entry 1062 </summary> 1063 </member> 1064 <member name="F:Delta.Utilitie…
Large files files are truncated, but you can click here to view the full file