DotZLib Namespace Reference

Classes
class	ChecksumGeneratorBase
	Implements the common functionality needed for all ChecksumGenerators More...
class	CRC32Checksum
	Implements a CRC32 checksum generator More...
class	AdlerChecksum
	Implements a checksum generator that computes the Adler checksum on data More...
class	CircularBuffer
	This class implements a circular buffer More...
class	CodecBase
	Implements the common functionality needed for all Codecs More...
class	Deflater
	Implements a data compressor, using the deflate algorithm in the ZLib dll More...
struct	ZStream
class	ZLibException
	The exception that is thrown when an error occurs on the zlib dll More...
interface	ChecksumGenerator
	Declares methods and properties that enables a running checksum to be calculated More...
interface	Codec
	Declares methods and events for implementing compressors/decompressors More...
class	Info
	Encapsulates general information about the ZLib library More...
class	GZipStream
	Implements a compressed Stream, in GZip (.gz) format. More...
class	Inflater
	Implements a data decompressor, using the inflate algorithm in the ZLib dll More...

Enumerations
enum class	FlushTypes {   None , Partial , Sync , Full ,   Finish , Block }
	Defines constants for the various flush types used with zlib More...
enum class	CompressLevel : int { Default = -1 , None = 0 , Best = 9 , Fastest = 1 }
	Defines constants for the available compression levels in zlib More...

Functions
delegate void	DataAvailableHandler (byte[] data, int startIndex, int count)
	Represents the method that will be called from a codec when new data are available. More...

Enumeration Type Documentation

CompressLevel

enum DotZLib.CompressLevel : int

strong

Defines constants for the available compression levels in zlib

Enumerator
Default	The default compression level with a reasonable compromise between compression and speed
None	No compression at all. The data are passed straight through.
Best	The maximum compression rate available.
Fastest	The fastest available compression level.

Definition at line 61 of file DotZLib.cs.

    {
        Default = -1,
        None = 0,
        Best = 9,
        Fastest = 1
    }

FlushTypes

enum DotZLib.FlushTypes

strongpackage

Defines constants for the various flush types used with zlib

Enumerator
None
Partial
Sync
Full
Finish
Block

Definition at line 22 of file DotZLib.cs.

    {
        None,  Partial,  Sync,  Full,  Finish,  Block
    }

Function Documentation

DataAvailableHandler()

delegate void DotZLib.DataAvailableHandler	(	byte[]	data,
		int	startIndex,
		int	count
	)

Represents the method that will be called from a codec when new data are available.

data The byte array containing the processed data startIndex The index of the first processed byte in data count The number of processed bytes available

On return from this method, the data may be overwritten, so grab it while you can. You cannot assume that startIndex will be zero.