C# Class Rebex.IO.Compression.ZlibOutputStream

Provides a writable stream that uses ZLIB algorithm to either compresses or decompresses data written to it and saves the resulting data blocks into an underlying stream. Unlike similar class present in .NET Framework 2.0, this one actually makes it possible to use Flush when compressing data to make sure all data written to the stream have been written into the underlying stream as well.

Inheritance: Stream

Mostra file Open project: Nanook/Queen-Bee Class Usage Examples

Public Methods

Method	Description
Close ( ) : void	Closes the current stream and the underlying stream.
Flush ( ) : void	Causes any buffered data to be written to the underlying stream.
Read ( byte buffer, int offset, int count ) : int	This method is not supported by the ZlibOutputStream class.
Seek ( long offset, SeekOrigin origin ) : long	This method is not supported by the ZlibOutputStream class. The new position within the current stream.
SetLength ( long value ) : void	This method is not supported by the ZlibOutputStream class.
Write ( byte buffer, int offset, int count ) : void	Writes a sequence of bytes into the current stream. The sequence will be compressed or decompressed and the result written into the underlying stream.
ZlibOutputStream ( Stream output, CompressionMode mode ) : System	Creates a new instance of ZlibOutputStream class.
ZlibOutputStream ( Stream output, CompressionMode mode, int level ) : System	Creates a new instance of ZlibOutputStream class.
ZlibOutputStream ( Stream output, bool compress, int level ) : System	Creates a new instance of ZlibOutputStream class.

Private Methods

Method	Description
WriteInternal ( byte buffer, int offset, int count, int flush ) : void

Method Details

Close() public method

Closes the current stream and the underlying stream.

public Close ( ) : void
return	void

Flush() public method

Causes any buffered data to be written to the underlying stream.

public Flush ( ) : void
return	void

Read() public method

This method is not supported by the ZlibOutputStream class.

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	An array of bytes. This method reads count bytes from buffer to the current stream.
offset	int	The zero-based byte offset in buffer at which to begin writing bytes to the current stream.
count	int	The number of bytes to be written to the current stream.
return	int

Seek() public method

This method is not supported by the ZlibOutputStream class.

The new position within the current stream.

public Seek ( long offset, SeekOrigin origin ) : long
offset	long	A byte offset relative to the origin parameter.
origin	SeekOrigin	A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.
return	long

SetLength() public method

This method is not supported by the ZlibOutputStream class.

public SetLength ( long value ) : void
value	long	The desired length of the current stream in bytes.
return	void

Write() public method

Writes a sequence of bytes into the current stream. The sequence will be compressed or decompressed and the result written into the underlying stream.

public Write ( byte buffer, int offset, int count ) : void
buffer	byte	An array of bytes. This method writes count bytes from buffer to the current stream.
offset	int	The zero-based byte offset in buffer at which to begin writing bytes to the current stream.
count	int	The number of bytes to be written to the current stream.
return	void

ZlibOutputStream() public method

Creates a new instance of ZlibOutputStream class.

public ZlibOutputStream ( Stream output, CompressionMode mode ) : System
output	Stream	Underlying stream that will receive the processed data written to the instance.
mode	CompressionMode	Specifies whether to compress or decompress data written to the stream.
return	System

ZlibOutputStream() public method

Creates a new instance of ZlibOutputStream class.

public ZlibOutputStream ( Stream output, CompressionMode mode, int level ) : System
output	Stream	Underlying stream that will receive the processed data written to the instance.
mode	CompressionMode	Specifies whether to compress or decompress data written to the stream.
level	int	Compresion level. Only used when compressing data.
return	System

ZlibOutputStream() public method

Creates a new instance of ZlibOutputStream class.

public ZlibOutputStream ( Stream output, bool compress, int level ) : System
output	Stream	Underlying stream that will receive the processed data written to the instance.
compress	bool	True to compress, false to decompress data written to the stream.
level	int	Compression level. Only used when compressing data.
return	System