C# Class Lz4Net.Lz4DecompressionStream

Stream to compress and write back data
Inheritance: Stream
Mostra file Open project: khalidsalomao/lz4-net Class Usage Examples

Public Methods

Method Description
Flush ( ) : void

Clears all buffers for this stream and causes any buffered data to be written to the underlying device.

Lz4DecompressionStream ( Stream sourceStream, bool closeStream = false ) : System

Initializes a new instance of the ZlibDecompressionStream class.

Read ( byte buffer, int offset, int count ) : int

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Seek ( long offset, SeekOrigin origin ) : long

[NotSupported] Sets the position within the current stream.

SetLength ( long value ) : void

Sets the length of the current stream.

Write ( byte buffer, int offset, int count ) : void

[NotSupported] Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the T:System.IO.Stream and optionally releases the managed resources.

Private Methods

Method Description
Fill ( ) : void

Fills or refills the read buffer.

Method Details

Dispose() protected method

Releases the unmanaged resources used by the T:System.IO.Stream and optionally releases the managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
return void

Flush() public method

Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
/// An I/O error occurs. ///
public Flush ( ) : void
return void

Lz4DecompressionStream() public method

Initializes a new instance of the ZlibDecompressionStream class.
public Lz4DecompressionStream ( Stream sourceStream, bool closeStream = false ) : System
sourceStream Stream The source stream.
closeStream bool The close stream.
return System

Read() public method

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
/// The sum of and is larger than the buffer length. /// /// is null. /// /// or is negative. /// /// An I/O error occurs. /// /// The stream does not support reading. /// /// Methods were called after the stream was closed. ///
public Read ( byte buffer, int offset, int count ) : int
buffer byte An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.
offset int The zero-based byte offset in at which to begin storing the data read from the current stream.
count int The maximum number of bytes to be read from the current stream.
return int

Seek() public method

[NotSupported] Sets the position within the current stream.
/// An I/O error occurs. /// /// The stream does not support seeking, such as if the stream is constructed from a pipe or console output. /// /// Methods were called after the stream was closed. ///
public Seek ( long offset, SeekOrigin origin ) : long
offset long A byte offset relative to the parameter.
origin SeekOrigin A value of type indicating the reference point used to obtain the new position.
return long

SetLength() public method

Sets the length of the current stream.
/// An I/O error occurs. /// /// The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. /// /// Methods were called after the stream was closed. ///
public SetLength ( long value ) : void
value long The desired length of the current stream in bytes.
return void

Write() public method

[NotSupported] Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
/// The sum of and is greater than the buffer length. /// /// is null. /// /// or is negative. /// /// An I/O error occurs. /// /// The stream does not support writing. /// /// Methods were called after the stream was closed. ///
public Write ( byte buffer, int offset, int count ) : void
buffer byte An array of bytes. This method copies bytes from to the current stream.
offset int The zero-based byte offset in at which to begin copying bytes to the current stream.
count int The number of bytes to be written to the current stream.
return void