C# Class Crisis.Ionic.Zlib.ZlibStream

Represents a Zlib stream for compression or decompression.

The ZlibStream is a Decorator on a . It adds ZLIB compression or decompression to any stream.

Using this stream, applications can compress or decompress data via stream Read() and Write() operations. Either compresssion or decompression can occur through either reading or writing. The compression format used is ZLIB, which is documented in IETF RFC 1950, "ZLIB Compressed Data Format Specification version 3.3". This implementation of ZLIB always uses DEFLATE as the compression method. (see IETF RFC 1951, "DEFLATE Compressed Data Format Specification version 1.3.")

The ZLIB format allows for varying compression methods, window sizes, and dictionaries. This implementation always uses the DEFLATE compression method, a preset dictionary, and 15 window bits by default.

This class is similar to DeflateStream, except that it adds the RFC1950 header and trailer bytes to a compressed stream when compressing, or expects the RFC1950 header and trailer bytes when decompressing. It is also similar to the GZipStream.

Inheritance: System.IO.Stream

Show file Open project: teeknofil/Crisis-Wordlist-Generator Class Usage Examples

Public Methods

Method	Description
CompressBuffer ( byte b ) : byte[]	Compress a byte array into a new byte array using ZLIB. Uncompress it with ZlibStream.UncompressBuffer(byte[]).
CompressString ( String s ) : byte[]	Compress a string into a byte array using ZLIB. Uncompress it with ZlibStream.UncompressString(byte[]).
Flush ( ) : void	Flush the stream.
Read ( byte buffer, int offset, int count ) : int	Read data from the stream. If you wish to use the `ZlibStream` to compress data while reading, you can create a `ZlibStream` with `CompressionMode.Compress`, providing an uncompressed data stream. Then call `Read()` on that `ZlibStream`, and the data read will be compressed. If you wish to use the `ZlibStream` to decompress data while reading, you can create a `ZlibStream` with `CompressionMode.Decompress`, providing a readable compressed data stream. Then call `Read()` on that `ZlibStream`, and the data will be decompressed as it is read. A `ZlibStream` can be used for `Read()` or `Write()`, but not both.
Seek ( long offset, System origin ) : long	Calling this method always throws a NotSupportedException.
SetLength ( long value ) : void	Calling this method always throws a NotSupportedException.
UncompressBuffer ( byte compressed ) : byte[]	Uncompress a ZLIB-compressed byte array into a byte array.
UncompressString ( byte compressed ) : String	Uncompress a ZLIB-compressed byte array into a single string.
Write ( byte buffer, int offset, int count ) : void	Write data to the stream. If you wish to use the `ZlibStream` to compress data while writing, you can create a `ZlibStream` with `CompressionMode.Compress`, and a writable output stream. Then call `Write()` on that `ZlibStream`, providing uncompressed data as input. The data sent to the output stream will be the compressed form of the data written. If you wish to use the `ZlibStream` to decompress data while writing, you can create a `ZlibStream` with `CompressionMode.Decompress`, and a writable output stream. Then call `Write()` on that stream, providing previously compressed data. The data sent to the output stream will be the decompressed form of the data written. A `ZlibStream` can be used for `Read()` or `Write()`, but not both.
ZlibStream ( System stream, CompressionMode mode ) : System	Create a `ZlibStream` using the specified `CompressionMode`. When mode is `CompressionMode.Compress`, the `ZlibStream` will use the default compression level. The "captive" stream will be closed when the `ZlibStream` is closed.
ZlibStream ( System stream, CompressionMode mode, CompressionLevel level ) : System	Create a `ZlibStream` using the specified `CompressionMode` and the specified `CompressionLevel`. When mode is `CompressionMode.Decompress`, the level parameter is ignored. The "captive" stream will be closed when the `ZlibStream` is closed.
ZlibStream ( System stream, CompressionMode mode, CompressionLevel level, bool leaveOpen ) : System	Create a `ZlibStream` using the specified `CompressionMode` and the specified `CompressionLevel`, and explicitly specify whether the stream should be left open after Deflation or Inflation. This constructor allows the application to request that the captive stream remain open after the deflation or inflation occurs. By default, after `Close()` is called on the stream, the captive stream is also closed. In some cases this is not desired, for example if the stream is a System.IO.MemoryStream that will be re-read after compression. Specify true for the parameter to leave the stream open. When mode is `CompressionMode.Decompress`, the level parameter is ignored.
ZlibStream ( System stream, CompressionMode mode, bool leaveOpen ) : System	Create a `ZlibStream` using the specified `CompressionMode`, and explicitly specify whether the captive stream should be left open after Deflation or Inflation. When mode is `CompressionMode.Compress`, the `ZlibStream` will use the default compression level. This constructor allows the application to request that the captive stream remain open after the deflation or inflation occurs. By default, after `Close()` is called on the stream, the captive stream is also closed. In some cases this is not desired, for example if the stream is a System.IO.MemoryStream that will be re-read after compression. Specify true for the leaveOpen parameter to leave the stream open. See the other overloads of this constructor for example code.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Dispose the stream. This may or may not result in a `Close()` call on the captive stream. See the constructors that have a `leaveOpen` parameter for more information. This method may be invoked in two distinct scenarios. If disposing == true, the method has been called directly or indirectly by a user's code, for example via the public Dispose() method. In this case, both managed and unmanaged resources can be referenced and disposed. If disposing == false, the method has been called by the runtime from inside the object finalizer and this method should not reference other objects; in that case only unmanaged resources must be referenced or disposed.

Method Details

CompressBuffer() public static method

Compress a byte array into a new byte array using ZLIB.

Uncompress it with ZlibStream.UncompressBuffer(byte[]).

public static CompressBuffer ( byte b ) : byte[]
b	byte	/// A buffer to compress. ///
return	byte[]

CompressString() public static method

Compress a string into a byte array using ZLIB.

Uncompress it with ZlibStream.UncompressString(byte[]).

public static CompressString ( String s ) : byte[]
s	String	/// A string to compress. The string will first be encoded /// using UTF8, then compressed. ///
return	byte[]

Dispose() protected method

Dispose the stream.

This may or may not result in a Close() call on the captive stream. See the constructors that have a leaveOpen parameter for more information.

This method may be invoked in two distinct scenarios. If disposing == true, the method has been called directly or indirectly by a user's code, for example via the public Dispose() method. In this case, both managed and unmanaged resources can be referenced and disposed. If disposing == false, the method has been called by the runtime from inside the object finalizer and this method should not reference other objects; in that case only unmanaged resources must be referenced or disposed.

protected Dispose ( bool disposing ) : void
disposing	bool	/// indicates whether the Dispose method was invoked by user code. ///
return	void

Flush() public method

Flush the stream.

public Flush ( ) : void
return	void

Read() public method

Read data from the stream.

If you wish to use the ZlibStream to compress data while reading, you can create a ZlibStream with CompressionMode.Compress, providing an uncompressed data stream. Then call Read() on that ZlibStream, and the data read will be compressed. If you wish to use the ZlibStream to decompress data while reading, you can create a ZlibStream with CompressionMode.Decompress, providing a readable compressed data stream. Then call Read() on that ZlibStream, and the data will be decompressed as it is read.

A ZlibStream can be used for Read() or Write(), but not both.

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	/// The buffer into which the read data should be placed.
offset	int	/// the offset within that data array to put the first byte read.
count	int	the number of bytes to read.
return	int

Seek() public method

Calling this method always throws a NotSupportedException.

public Seek ( long offset, System origin ) : long
offset	long	/// The offset to seek to.... /// IF THIS METHOD ACTUALLY DID ANYTHING. ///
origin	System	/// The reference specifying how to apply the offset.... IF /// THIS METHOD ACTUALLY DID ANYTHING. ///
return	long

SetLength() public method

Calling this method always throws a NotSupportedException.

public SetLength ( long value ) : void
value	long	/// The new value for the stream length.... IF /// THIS METHOD ACTUALLY DID ANYTHING. ///
return	void

UncompressBuffer() public static method

Uncompress a ZLIB-compressed byte array into a byte array.

public static UncompressBuffer ( byte compressed ) : byte[]
compressed	byte	/// A buffer containing ZLIB-compressed data. ///
return	byte[]

UncompressString() public static method

Uncompress a ZLIB-compressed byte array into a single string.

public static UncompressString ( byte compressed ) : String
compressed	byte	/// A buffer containing ZLIB-compressed data. ///
return	String

Write() public method

Write data to the stream.

If you wish to use the ZlibStream to compress data while writing, you can create a ZlibStream with CompressionMode.Compress, and a writable output stream. Then call Write() on that ZlibStream, providing uncompressed data as input. The data sent to the output stream will be the compressed form of the data written. If you wish to use the ZlibStream to decompress data while writing, you can create a ZlibStream with CompressionMode.Decompress, and a writable output stream. Then call Write() on that stream, providing previously compressed data. The data sent to the output stream will be the decompressed form of the data written.

A ZlibStream can be used for Read() or Write(), but not both.

public Write ( byte buffer, int offset, int count ) : void
buffer	byte	The buffer holding data to write to the stream.
offset	int	the offset within that data array to find the first byte to write.
count	int	the number of bytes to write.
return	void

ZlibStream() public method

Create a ZlibStream using the specified CompressionMode.

When mode is CompressionMode.Compress, the ZlibStream will use the default compression level. The "captive" stream will be closed when the ZlibStream is closed.

public ZlibStream ( System stream, CompressionMode mode ) : System
stream	System	The stream which will be read or written.
mode	CompressionMode	Indicates whether the ZlibStream will compress or decompress.
return	System

ZlibStream() public method

Create a ZlibStream using the specified CompressionMode and the specified CompressionLevel.

When mode is CompressionMode.Decompress, the level parameter is ignored. The "captive" stream will be closed when the ZlibStream is closed.

public ZlibStream ( System stream, CompressionMode mode, CompressionLevel level ) : System
stream	System	The stream to be read or written while deflating or inflating.
mode	CompressionMode	Indicates whether the ZlibStream will compress or decompress.
level	CompressionLevel	A tuning knob to trade speed for effectiveness.
return	System

ZlibStream() public method

Create a ZlibStream using the specified CompressionMode and the specified CompressionLevel, and explicitly specify whether the stream should be left open after Deflation or Inflation.

This constructor allows the application to request that the captive stream remain open after the deflation or inflation occurs. By default, after Close() is called on the stream, the captive stream is also closed. In some cases this is not desired, for example if the stream is a System.IO.MemoryStream that will be re-read after compression. Specify true for the parameter to leave the stream open.

When mode is CompressionMode.Decompress, the level parameter is ignored.

public ZlibStream ( System stream, CompressionMode mode, CompressionLevel level, bool leaveOpen ) : System
stream	System	The stream which will be read or written.
mode	CompressionMode	Indicates whether the ZlibStream will compress or decompress.
level	CompressionLevel	/// A tuning knob to trade speed for effectiveness. This parameter is /// effective only when mode is CompressionMode.Compress. ///
leaveOpen	bool	/// true if the application would like the stream to remain open after /// inflation/deflation. ///
return	System

ZlibStream() public method

Create a ZlibStream using the specified CompressionMode, and explicitly specify whether the captive stream should be left open after Deflation or Inflation.

When mode is CompressionMode.Compress, the ZlibStream will use the default compression level.

See the other overloads of this constructor for example code.

public ZlibStream ( System stream, CompressionMode mode, bool leaveOpen ) : System
stream	System	The stream which will be read or written. This is called the /// "captive" stream in other places in this documentation.
mode	CompressionMode	Indicates whether the ZlibStream will compress or decompress.
leaveOpen	bool	true if the application would like the stream to remain /// open after inflation/deflation.
return	System