Implements a compressed Stream, in GZip (.gz) format. More...

Inheritance diagram for DotZLib.GZipStream:

Public Member Functions
	GZipStream (string fileName, CompressLevel level)
	Creates a new file as a writeable GZipStream More...

	GZipStream (string fileName)
	Opens an existing file as a readable GZipStream More...

void	Dispose ()
	Closes the external file handle More...

override int	Read (byte[] buffer, int offset, int count)
	Attempts to read a number of bytes from the stream. More...

override int	ReadByte ()
	Attempts to read a single byte from the stream. More...

override void	Write (byte[] buffer, int offset, int count)
	Writes a number of bytes to the stream More...

override void	WriteByte (byte value)
	Writes a single byte to the stream More...

override void	SetLength (long value)
	Not supported. More...

override long	Seek (long offset, SeekOrigin origin)
	Not suppported. More...

override void	Flush ()
	Flushes the `GZipStream`. More...

Properties
override bool	CanRead `[get]`
	Returns true of this stream can be read from, false otherwise More...

override bool	CanSeek `[get]`
	Returns false. More...

override bool	CanWrite `[get]`
	Returns true if this tsream is writeable, false otherwise More...

override long	Position `[get, set]`
	Gets/sets the current position in the `GZipStream`. Not suppported. More...

override long	Length `[get]`
	Gets the size of the stream. Not suppported. More...

Private Member Functions
static IntPtr	gzopen (string name, string mode)

static int	gzclose (IntPtr gzFile)

static int	gzwrite (IntPtr gzFile, int data, int length)

static int	gzread (IntPtr gzFile, int data, int length)

static int	gzgetc (IntPtr gzFile)

static int	gzputc (IntPtr gzFile, int c)

	~GZipStream ()
	Destroys this instance More...

void	cleanUp (bool isDisposing)

Private Attributes
IntPtr	_gzFile

bool	_isDisposed = false

bool	_isWriting

Additional Inherited Members
Public Attributes inherited from Stream
const char *	input

const char *	start

const char *	end

int32_t	next

uint8_t	next_size

Detailed Description

Implements a compressed Stream, in GZip (.gz) format.

Definition at line 17 of file GZipStream.cs.

Constructor & Destructor Documentation

◆ GZipStream() [1/2]

DotZLib.GZipStream.GZipStream	(	string	fileName,
		CompressLevel	level
	)

inline

Creates a new file as a writeable GZipStream

Parameters

fileName	The name of the compressed file to create
level	The compression level to use when adding data

Exceptions

ZLibException If an error occurred in the internal zlib function

Definition at line 53 of file GZipStream.cs.

         {
             _isWriting = true;
             _gzFile = gzopen(fileName, String.Format("wb{0}", (int)level));
             if (_gzFile == IntPtr.Zero)
                 throw new ZLibException(-1, "Could not open " + fileName);
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isWriting, test-lz4-speed.fileName, DotZLib.GZipStream.gzopen(), and level.

◆ GZipStream() [2/2]

DotZLib.GZipStream.GZipStream ( string fileName )

inline

Opens an existing file as a readable GZipStream

Parameters

fileName The name of the file to open

Exceptions

ZLibException If an error occurred in the internal zlib function

Definition at line 66 of file GZipStream.cs.

         {
             _isWriting = false;
             _gzFile = gzopen(fileName, "rb");
             if (_gzFile == IntPtr.Zero)
                 throw new ZLibException(-1, "Could not open " + fileName);
  
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isWriting, test-lz4-speed.fileName, and DotZLib.GZipStream.gzopen().

◆ ~GZipStream()

DotZLib.GZipStream.~GZipStream ( )

inlineprivate

Destroys this instance

Definition at line 117 of file GZipStream.cs.

         {
             cleanUp(false);
         }

References DotZLib.GZipStream.cleanUp().

Member Function Documentation

◆ cleanUp()

void DotZLib.GZipStream.cleanUp ( bool isDisposing )

inlineprivate

Definition at line 131 of file GZipStream.cs.

         {
             if (!_isDisposed)
             {
                 gzclose(_gzFile);
                 _isDisposed = true;
             }
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isDisposed, and DotZLib.GZipStream.gzclose().

Referenced by DotZLib.GZipStream.Dispose(), and DotZLib.GZipStream.~GZipStream().

◆ Dispose()

void DotZLib.GZipStream.Dispose ( )

inline

Closes the external file handle

Definition at line 125 of file GZipStream.cs.

         {
             cleanUp(true);
         }

References DotZLib.GZipStream.cleanUp().

◆ Flush()

override void DotZLib.GZipStream.Flush ( )

inline

Flushes the GZipStream.

In this implementation, this method does nothing. This is because excessive flushing may degrade the achievable compression rates.

Definition at line 265 of file GZipStream.cs.

         {
             // left empty on purpose
         }

◆ gzclose()

static int DotZLib.GZipStream.gzclose ( IntPtr gzFile )

private

Referenced by DotZLib.GZipStream.cleanUp().

◆ gzgetc()

static int DotZLib.GZipStream.gzgetc ( IntPtr gzFile )

private

Referenced by DotZLib.GZipStream.ReadByte().

◆ gzopen()

static IntPtr DotZLib.GZipStream.gzopen	(	string	name,
		string	mode
	)

private

Referenced by DotZLib.GZipStream.GZipStream().

◆ gzputc()

static int DotZLib.GZipStream.gzputc	(	IntPtr	gzFile,
		int	c
	)

private

Referenced by DotZLib.GZipStream.WriteByte().

◆ gzread()

static int DotZLib.GZipStream.gzread	(	IntPtr	gzFile,
		int	data,
		int	length
	)

private

Referenced by DotZLib.GZipStream.Read().

◆ gzwrite()

static int DotZLib.GZipStream.gzwrite	(	IntPtr	gzFile,
		int	data,
		int	length
	)

private

Referenced by DotZLib.GZipStream.Write().

◆ Read()

override int DotZLib.GZipStream.Read	(	byte[]	buffer,
		int	offset,
		int	count
	)

inline

Attempts to read a number of bytes from the stream.

Parameters

buffer	The destination data buffer
offset	The index of the first destination byte in `buffer`
count	The number of bytes requested

Returns: The number of bytes read

Exceptions

ArgumentNullException	If `buffer` is null
ArgumentOutOfRangeException	If `count` or `offset` are negative
ArgumentException	If `offset` + `count` is > buffer.Length
NotSupportedException	If this stream is not readable.
ObjectDisposedException	If this stream has been disposed.

Definition at line 154 of file GZipStream.cs.

         {
             if (!CanRead) throw new NotSupportedException();
             if (buffer == null) throw new ArgumentNullException();
             if (offset < 0 || count < 0) throw new ArgumentOutOfRangeException();
             if ((offset+count) > buffer.Length) throw new ArgumentException();
             if (_isDisposed) throw new ObjectDisposedException("GZipStream");
  
             GCHandle h = GCHandle.Alloc(buffer, GCHandleType.Pinned);
             int result;
             try
             {
                 result = gzread(_gzFile, h.AddrOfPinnedObject().ToInt32() + offset, count);
                 if (result < 0)
                     throw new IOException();
             }
             finally
             {
                 h.Free();
             }
             return result;
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isDisposed, DotZLib.GZipStream.CanRead, count, DotZLib.GZipStream.gzread(), and h.

◆ ReadByte()

override int DotZLib.GZipStream.ReadByte ( )

inline

Attempts to read a single byte from the stream.

Returns: The byte that was read, or -1 in case of error or End-Of-File

Definition at line 181 of file GZipStream.cs.

         {
             if (!CanRead) throw new NotSupportedException();
             if (_isDisposed) throw new ObjectDisposedException("GZipStream");
             return gzgetc(_gzFile);
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isDisposed, DotZLib.GZipStream.CanRead, and DotZLib.GZipStream.gzgetc().

◆ Seek()

override long DotZLib.GZipStream.Seek	(	long	offset,
		SeekOrigin	origin
	)

inline

Not suppported.

Parameters

offset
origin

Returns

Exceptions

NotSupportedException Always thrown

Definition at line 255 of file GZipStream.cs.

         {
             throw new NotSupportedException();
         }

◆ SetLength()

override void DotZLib.GZipStream.SetLength ( long value )

inline

Not supported.

Parameters

value

Exceptions

NotSupportedException Always thrown

Definition at line 243 of file GZipStream.cs.

         {
             throw new NotSupportedException();
         }

◆ Write()

override void DotZLib.GZipStream.Write	(	byte[]	buffer,
		int	offset,
		int	count
	)

inline

Writes a number of bytes to the stream

Parameters

buffer
offset
count

Exceptions

ArgumentNullException	If `buffer` is null
ArgumentOutOfRangeException	If `count` or `offset` are negative
ArgumentException	If `offset` + `count` is > buffer.Length
NotSupportedException	If this stream is not writeable.
ObjectDisposedException	If this stream has been disposed.

Definition at line 199 of file GZipStream.cs.

         {
             if (!CanWrite) throw new NotSupportedException();
             if (buffer == null) throw new ArgumentNullException();
             if (offset < 0 || count < 0) throw new ArgumentOutOfRangeException();
             if ((offset+count) > buffer.Length) throw new ArgumentException();
             if (_isDisposed) throw new ObjectDisposedException("GZipStream");
  
             GCHandle h = GCHandle.Alloc(buffer, GCHandleType.Pinned);
             try
             {
                 int result = gzwrite(_gzFile, h.AddrOfPinnedObject().ToInt32() + offset, count);
                 if (result < 0)
                     throw new IOException();
             }
             finally
             {
                 h.Free();
             }
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isDisposed, DotZLib.GZipStream.CanWrite, count, DotZLib.GZipStream.gzwrite(), and h.

◆ WriteByte()

override void DotZLib.GZipStream.WriteByte ( byte value )

inline

Writes a single byte to the stream

Parameters

value The byte to add to the stream.

Exceptions

NotSupportedException	If this stream is not writeable.
ObjectDisposedException	If this stream has been disposed.

Definition at line 226 of file GZipStream.cs.

         {
             if (!CanWrite) throw new NotSupportedException();
             if (_isDisposed) throw new ObjectDisposedException("GZipStream");
  
             int result = gzputc(_gzFile, (int)value);
             if (result < 0)
                 throw new IOException();
         }

References DotZLib.GZipStream._gzFile, DotZLib.GZipStream._isDisposed, DotZLib.GZipStream.CanWrite, DotZLib.GZipStream.gzputc(), and value.

Member Data Documentation

◆ _gzFile

IntPtr DotZLib.GZipStream._gzFile

private

Definition at line 41 of file GZipStream.cs.

Referenced by DotZLib.GZipStream.cleanUp(), DotZLib.GZipStream.GZipStream(), DotZLib.GZipStream.Read(), DotZLib.GZipStream.ReadByte(), DotZLib.GZipStream.Write(), and DotZLib.GZipStream.WriteByte().

◆ _isDisposed

bool DotZLib.GZipStream._isDisposed = false

private

Definition at line 42 of file GZipStream.cs.

Referenced by DotZLib.GZipStream.cleanUp(), DotZLib.GZipStream.Read(), DotZLib.GZipStream.ReadByte(), DotZLib.GZipStream.Write(), and DotZLib.GZipStream.WriteByte().

◆ _isWriting

bool DotZLib.GZipStream._isWriting

private

Definition at line 43 of file GZipStream.cs.

Referenced by DotZLib.GZipStream.GZipStream().

Property Documentation

◆ CanRead

override bool DotZLib.GZipStream.CanRead

get

Returns true of this stream can be read from, false otherwise

Definition at line 80 of file GZipStream.cs.

         {
             get
             {
                 return !_isWriting;
             }
         }

Referenced by DotZLib.GZipStream.Read(), and DotZLib.GZipStream.ReadByte().

◆ CanSeek

override bool DotZLib.GZipStream.CanSeek

get

Returns false.

Definition at line 92 of file GZipStream.cs.

         {
             get
             {
                 return false;
             }
         }

◆ CanWrite

override bool DotZLib.GZipStream.CanWrite

get

Returns true if this tsream is writeable, false otherwise

Definition at line 103 of file GZipStream.cs.

         {
             get
             {
                 return _isWriting;
             }
         }

Referenced by DotZLib.GZipStream.Write(), and DotZLib.GZipStream.WriteByte().

◆ Length

override long DotZLib.GZipStream.Length

get

Gets the size of the stream. Not suppported.

In this implementation this property is not supported

Exceptions

NotSupportedException Always thrown

Definition at line 292 of file GZipStream.cs.

         {
             get
             {
                 throw new NotSupportedException();
             }
         }

◆ Position

override long DotZLib.GZipStream.Position

getset

Gets/sets the current position in the GZipStream. Not suppported.

In this implementation this property is not supported

Exceptions

NotSupportedException Always thrown

Definition at line 275 of file GZipStream.cs.

         {
             get
             {
                 throw new NotSupportedException();
             }
             set
             {
                 throw new NotSupportedException();
             }
         }

The documentation for this class was generated from the following file:

subprojects/zlib-1.2.12/contrib/dotzlib/DotZLib/GZipStream.cs

Public Member Functions

Properties

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GZipStream() [1/2]

◆ GZipStream() [2/2]

◆ ~GZipStream()

Member Function Documentation

◆ cleanUp()

◆ Dispose()

◆ Flush()

◆ gzclose()

◆ gzgetc()

◆ gzopen()

◆ gzputc()

◆ gzread()

◆ gzwrite()

◆ Read()

◆ ReadByte()

◆ Seek()

◆ SetLength()

◆ Write()

◆ WriteByte()

Member Data Documentation

◆ _gzFile

◆ _isDisposed

◆ _isWriting

Property Documentation

◆ CanRead

◆ CanSeek

◆ CanWrite

◆ Length

◆ Position