C# Class NetWrok.HTTP.Zlib.DeflateStream

A class for compressing and decompressing streams using the Deflate algorithm.

Data can be compressed or decompressed, and either of those can be through reading or writing. For more information on the Deflate algorithm, see IETF RFC 1951, "DEFLATE Compressed Data Format Specification version 1.3."

This class is similar to ZlibStream, except that ZlibStream adds the RFC1950 header bytes to a compressed stream when compressing, or expects the RFC1950 header bytes when decompressing. The DeflateStream does not.

Inheritance: System.IO.Stream

Show file Open project: simonwittber/netwrok-client

Public Methods

Method	Description
Close ( ) : void	Close the stream. This may or may not close the captive stream. See the ctor's with leaveOpen parameters for more information.
DeflateStream ( System stream, CompressionMode mode ) : System	Create a DeflateStream using the specified CompressionMode. The DeflateStream will use the default compression level.
DeflateStream ( System stream, CompressionMode mode, CompressionLevel level ) : System	Create a DeflateStream using the specified CompressionMode and the specified CompressionLevel.
DeflateStream ( System stream, CompressionMode mode, CompressionLevel level, bool leaveOpen ) : System	Create a DeflateStream 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 memory stream that will be re-read after compression. Specify true for the leaveOpen parameter to leave the stream open.
DeflateStream ( System stream, CompressionMode mode, bool leaveOpen ) : System	Create a DeflateStream using the specified CompressionMode, 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 memory stream that will be re-read after compression. Specify true for the leaveOpen parameter to leave the stream open. The DeflateStream will use the default compression level. See the other overloads of this constructor for example code.
Flush ( ) : void	Flush the stream.
Read ( byte buffer, int offset, int count ) : int	Read data from the stream. If you wish to use the DeflateStream to compress data while reading, you can create a DeflateStream with CompressionMode.Compress, providing an uncompressed data stream. Then call Read() on that DeflateStream, and the data read will be compressed. If you wish to use the DeflateStream to decompress data while reading, you can create a DeflateStream with CompressionMode.Decompress, providing a readable compressed data stream. Then call Read() on that DeflateStream, and the data read will be decompressed. A DeflateStream can be used for Read() or Write(), but not both.
Seek ( long offset, System origin ) : long	Calling this method always throws a NotImplementedException.
SetLength ( long value ) : void	Calling this method always throws a NotImplementedException.
Write ( byte buffer, int offset, int count ) : void	Write data to the stream. If you wish to use the DeflateStream to compress data while writing, you can create a DeflateStream with CompressionMode.Compress, and a writable output stream. Then call Write() on that DeflateStream, 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 DeflateStream to decompress data while writing, you can create a DeflateStream 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 DeflateStream can be used for Read() or Write(), but not both.

Method Details

Close() public method

Close the stream.

This may or may not close the captive stream. See the ctor's with leaveOpen parameters for more information.

public Close ( ) : void
return	void

DeflateStream() public method

Create a DeflateStream using the specified CompressionMode.

The DeflateStream will use the default compression level.

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

DeflateStream() public method

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

public DeflateStream ( 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 DeflateStream will compress or decompress.
level	CompressionLevel	A tuning knob to trade speed for effectiveness.
return	System

DeflateStream() public method

Create a DeflateStream 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 memory stream that will be re-read after compression. Specify true for the leaveOpen parameter to leave the stream open.

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

DeflateStream() public method

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

The DeflateStream will use the default compression level.

See the other overloads of this constructor for example code.

public DeflateStream ( 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 DeflateStream will compress or decompress.
leaveOpen	bool	true if the application would like the stream to remain open after inflation/deflation.
return	System

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 DeflateStream to compress data while reading, you can create a DeflateStream with CompressionMode.Compress, providing an uncompressed data stream. Then call Read() on that DeflateStream, and the data read will be compressed. If you wish to use the DeflateStream to decompress data while reading, you can create a DeflateStream with CompressionMode.Decompress, providing a readable compressed data stream. Then call Read() on that DeflateStream, and the data read will be decompressed.

A DeflateStream 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 NotImplementedException.

public Seek ( long offset, System origin ) : long
offset	long	this is irrelevant, since it will always throw!
origin	System	this is irrelevant, since it will always throw!
return	long

SetLength() public method

Calling this method always throws a NotImplementedException.

public SetLength ( long value ) : void
value	long	this is irrelevant, since it will always throw!
return	void

Write() public method

Write data to the stream.

If you wish to use the DeflateStream to compress data while writing, you can create a DeflateStream with CompressionMode.Compress, and a writable output stream. Then call Write() on that DeflateStream, 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 DeflateStream to decompress data while writing, you can create a DeflateStream 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 DeflateStream 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