UnixCompressStream Class
Decompresses the data of the Unix compress command (.Z): LZW codes of 9 to 16 bits, with or without the block mode that clears the table. Invalid data throw an InvalidDataException. This stream cannot compress data.
public sealed class UnixCompressStream : Stream- Inheritance
StreamUnixCompressStream
Constructors
| Name | Description |
|---|---|
| UnixCompressStream(Stream, bool) | Initializes a new instance of the UnixCompressStream class to decompress a stream. |
UnixCompressStream(Stream, bool)
UnixCompressStream.csInitializes a new instance of the UnixCompressStream class to decompress a stream.
Properties
| Name | Description |
|---|---|
| BaseStream | Gets the stream the compressed data are read from. |
| CanRead | When overridden in a derived class, gets a value indicating whether the current stream supports reading. |
| CanSeek | When overridden in a derived class, gets a value indicating whether the current stream supports seeking. |
| CanWrite | When overridden in a derived class, gets a value indicating whether the current stream supports writing. |
| Length | When overridden in a derived class, gets the length in bytes of the stream. |
| Position | When overridden in a derived class, gets or sets the position within the current stream. |
BaseStream
UnixCompressStream.csCanRead
UnixCompressStream.csCanSeek
UnixCompressStream.csCanWrite
UnixCompressStream.csLength
UnixCompressStream.csWhen overridden in a derived class, gets the length in bytes of the stream.
public override long Length { get; }Property value
Exceptions
NotSupportedException- A class derived from
Streamdoes not support seeking and the length is unknown. ObjectDisposedException- Methods were called after the stream was closed.
Position
UnixCompressStream.csWhen overridden in a derived class, gets or sets the position within the current stream.
public override long Position { get; set; }Property value
Exceptions
IOException- An I/O error occurs.
NotSupportedException- The stream does not support seeking.
ObjectDisposedException- Methods were called after the stream was closed.
Methods
| Name | Description |
|---|---|
| Flush() | When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. |
| Read(byte[], int, int) | When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. |
| Read(Span<byte>) | When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. |
| ReadAsync(byte[], int, int, CancellationToken) | Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. |
| ReadAsync(Memory<byte>, CancellationToken) | Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. |
| ReadByte() | Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. |
| Seek(long, SeekOrigin) | When overridden in a derived class, sets the position within the current stream. |
| SetLength(long) | When overridden in a derived class, sets the length of the current stream. |
| Write(byte[], int, int) | Throws a NotSupportedException: this stream cannot compress data. |
| Write(ReadOnlySpan<byte>) | Throws a NotSupportedException: this stream cannot compress data. |
Flush()
UnixCompressStream.csWhen overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
public override void Flush()Exceptions
IOException- An I/O error occurs.
Read overloads
Read(byte[], int, int)
UnixCompressStream.csWhen overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
Parameters
bufferbyte[]- An array of bytes. When this method returns, the buffer contains the specified byte array with the values between
offsetand (offset+count- 1) replaced by the bytes read from the current source. offsetint- The zero-based byte offset in
bufferat which to begin storing the data read from the current stream. countint- The maximum number of bytes to be read from the current stream.
Returns
int The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached.
Exceptions
ArgumentException- The sum of
offsetandcountis larger than the buffer length. ArgumentNullExceptionbufferisnull.ArgumentOutOfRangeExceptionoffsetorcountis negative.IOException- An I/O error occurs.
NotSupportedException- The stream does not support reading.
ObjectDisposedException- Methods were called after the stream was closed.
Read(Span<byte>)
UnixCompressStream.csWhen overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
Parameters
bufferSpan<byte>- A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.
Returns
int The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached.
ReadAsync overloads
ReadAsync(byte[], int, int, CancellationToken)
UnixCompressStream.csAsynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)Parameters
bufferbyte[]- The buffer to write the data into.
offsetint- The byte offset in
bufferat which to begin writing data from the stream. countint- The maximum number of bytes to read.
cancellationTokenCancellationToken- The token to monitor for cancellation requests. The default value is
CancellationToken.None.
Returns
Task<int> A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached.
Exceptions
ArgumentNullExceptionbufferisnull.ArgumentOutOfRangeExceptionoffsetorcountis negative.ArgumentException- The sum of
offsetandcountis larger than the buffer length. NotSupportedException- The stream does not support reading.
ObjectDisposedException- The stream has been disposed.
InvalidOperationException- The stream is currently in use by a previous read operation.
OperationCanceledException- The cancellation token was canceled. This exception is stored into the returned task.
ReadAsync(Memory<byte>, CancellationToken)
UnixCompressStream.csAsynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)Parameters
bufferMemory<byte>- The region of memory to write the data into.
cancellationTokenCancellationToken- The token to monitor for cancellation requests. The default value is
CancellationToken.None.
Returns
ValueTask<int> A task that represents the asynchronous read operation. The value of its ValueTask<TResult>.Result property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.
Exceptions
OperationCanceledException- The cancellation token was canceled. This exception is stored into the returned task.
ReadByte()
UnixCompressStream.csReads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
public override int ReadByte()Returns
int The unsigned byte cast to an Int32, or -1 if at the end of the stream.
Exceptions
NotSupportedException- The stream does not support reading.
ObjectDisposedException- Methods were called after the stream was closed.
Seek(long, SeekOrigin)
UnixCompressStream.csWhen overridden in a derived class, sets the position within the current stream.
public override long Seek(long offset, SeekOrigin origin)Parameters
offsetlong- A byte offset relative to the
originparameter. originSeekOrigin- A value of type
SeekOriginindicating the reference point used to obtain the new position.
Returns
long The new position within the current stream.
Exceptions
IOException- An I/O error occurs.
NotSupportedException- The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException- Methods were called after the stream was closed.
SetLength(long)
UnixCompressStream.csWhen overridden in a derived class, sets the length of the current stream.
Parameters
valuelong- The desired length of the current stream in bytes.
Exceptions
IOException- An I/O error occurs.
NotSupportedException- The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException- Methods were called after the stream was closed.
Write overloads
Write(byte[], int, int)
UnixCompressStream.csWrite(ReadOnlySpan<byte>)
UnixCompressStream.csThrows a NotSupportedException: this stream cannot compress data.
public override void Write(ReadOnlySpan<byte> buffer)Parameters
bufferReadOnlySpan<byte>- The data.