LzmaStream Class
Compresses and decompresses the "LZMA alone" format (.lzma) of the LZMA SDK and of xz-utils, like GZipStream does for gzip.
public sealed class LzmaStream : StreamRemarks
The format is a 13-byte header (the LZMA properties, the dictionary size and the uncompressed size), then the LZMA data. The decompression reads the data up to the uncompressed size of the header, or up to the end marker when the size is unknown. Corrupt data throws an InvalidDataException.
The compression writes an unknown size and an end marker. LZMA cannot end a block in the middle of the data: LzmaStream.Flush writes the compressed data available so far, and the data can be decompressed once the stream is disposed.
- Inheritance
StreamLzmaStream
Constructors
| Name | Description |
|---|---|
| LzmaStream(Stream, LzmaCompressionOptions, bool) | Initializes a new instance of the LzmaStream class that compresses with options. |
| LzmaStream(Stream, CompressionLevel, bool) | Initializes a new instance of the LzmaStream class that compresses at a compression level. |
| LzmaStream(Stream, CompressionMode, bool) | Initializes a new instance of the LzmaStream class that compresses with the default options, or decompresses. |
LzmaStream overloads
LzmaStream(Stream, LzmaCompressionOptions, bool)
LzmaStream.csInitializes a new instance of the LzmaStream class that compresses with options.
public LzmaStream(Stream stream, LzmaCompressionOptions options, bool leaveOpen = false)Parameters
streamStream- The stream to write the compressed data to.
optionsLzmaCompressionOptions- The options of the compression.
leaveOpenbooltrueto leavestreamopen when the stream is disposed.
LzmaStream(Stream, CompressionLevel, bool)
LzmaStream.csInitializes a new instance of the LzmaStream class that compresses at a compression level.
public LzmaStream(Stream stream, CompressionLevel compressionLevel, bool leaveOpen = false)Parameters
streamStream- The stream to write the compressed data to.
compressionLevelCompressionLevel- The compression level:
CompressionLevel.Optimalis the preset 6,CompressionLevel.Fastestthe preset 1,CompressionLevel.NoCompressionthe preset 0, andCompressionLevel.SmallestSizethe preset 9. leaveOpenbooltrueto leavestreamopen when the stream is disposed.
LzmaStream(Stream, CompressionMode, bool)
LzmaStream.csInitializes a new instance of the LzmaStream class that compresses with the default options, or decompresses.
public LzmaStream(Stream stream, CompressionMode mode, bool leaveOpen = false)Parameters
streamStream- The stream to write the compressed data to, or to read it from.
modeCompressionMode- Whether to compress or decompress.
leaveOpenbooltrueto leavestreamopen when the stream is disposed.
Properties
| Name | Description |
|---|---|
| BaseStream | Gets the stream that contains the compressed data. |
| 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
LzmaStream.csCanRead
LzmaStream.csCanSeek
LzmaStream.csCanWrite
LzmaStream.csLength
LzmaStream.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
LzmaStream.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 |
|---|---|
| DisposeAsync() | Asynchronously releases the unmanaged resources used by the Stream. |
| 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. |
| FlushAsync(CancellationToken) | Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. |
| 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) | When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. |
| Write(ReadOnlySpan<byte>) | When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. |
| WriteAsync(byte[], int, int, CancellationToken) | Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. |
| WriteAsync(ReadOnlyMemory<byte>, CancellationToken) | Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. |
| WriteByte(byte) | Writes a byte to the current position in the stream and advances the position within the stream by one byte. |
DisposeAsync()
LzmaStream.csFlush()
LzmaStream.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.
FlushAsync(CancellationToken)
LzmaStream.csAsynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
public override Task FlushAsync(CancellationToken cancellationToken)Parameters
cancellationTokenCancellationToken- The token to monitor for cancellation requests. The default value is
CancellationToken.None.
Returns
Task A task that represents the asynchronous flush operation.
Exceptions
ObjectDisposedException- The stream has been disposed.
OperationCanceledException- The cancellation token was canceled. This exception is stored into the returned task.
Read overloads
Read(byte[], int, int)
LzmaStream.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>)
LzmaStream.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)
LzmaStream.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)
LzmaStream.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()
LzmaStream.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)
LzmaStream.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)
LzmaStream.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)
LzmaStream.csWhen overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
Parameters
bufferbyte[]- An array of bytes. This method copies
countbytes frombufferto the current stream. offsetint- The zero-based byte offset in
bufferat which to begin copying bytes to the current stream. countint- The number of bytes to be written to the current stream.
Exceptions
ArgumentException- The sum of
offsetandcountis greater than the buffer length. ArgumentNullExceptionbufferisnull.ArgumentOutOfRangeExceptionoffsetorcountis negative.IOException- An I/O error occurred, such as the specified file cannot be found.
NotSupportedException- The stream does not support writing.
ObjectDisposedExceptionStream.Writewas called after the stream was closed.
Write(ReadOnlySpan<byte>)
LzmaStream.csWhen overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
public override void Write(ReadOnlySpan<byte> buffer)Parameters
bufferReadOnlySpan<byte>- A region of memory. This method copies the contents of this region to the current stream.
WriteAsync overloads
WriteAsync(byte[], int, int, CancellationToken)
LzmaStream.csAsynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)Parameters
bufferbyte[]- The buffer to write data from.
offsetint- The zero-based byte offset in
bufferfrom which to begin copying bytes to the stream. countint- The maximum number of bytes to write.
cancellationTokenCancellationToken- The token to monitor for cancellation requests. The default value is
CancellationToken.None.
Returns
Task A task that represents the asynchronous write operation.
Exceptions
ArgumentNullExceptionbufferisnull.ArgumentOutOfRangeExceptionoffsetorcountis negative.ArgumentException- The sum of
offsetandcountis larger than the buffer length. NotSupportedException- The stream does not support writing.
ObjectDisposedException- The stream has been disposed.
InvalidOperationException- The stream is currently in use by a previous write operation.
OperationCanceledException- The cancellation token was canceled. This exception is stored into the returned task.
WriteAsync(ReadOnlyMemory<byte>, CancellationToken)
LzmaStream.csAsynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)Parameters
bufferReadOnlyMemory<byte>- The region of memory to write data from.
cancellationTokenCancellationToken- The token to monitor for cancellation requests. The default value is
CancellationToken.None.
Returns
ValueTask A task that represents the asynchronous write operation.
Exceptions
OperationCanceledException- The cancellation token was canceled. This exception is stored into the returned task.
WriteByte(byte)
LzmaStream.csWrites a byte to the current position in the stream and advances the position within the stream by one byte.
Parameters
valuebyte- The byte to write to the stream.
Exceptions
IOException- An I/O error occurs.
NotSupportedException- The stream does not support writing, or the stream is already closed.
ObjectDisposedException- Methods were called after the stream was closed.