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 : Stream

Remarks

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
Stream LzmaStream

Constructors

NameDescription
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.cs

Initializes a new instance of the LzmaStream class that compresses with options.

public LzmaStream(Stream stream, LzmaCompressionOptions options, bool leaveOpen = false)
Parameters
stream Stream
The stream to write the compressed data to.
options LzmaCompressionOptions
The options of the compression.
leaveOpen bool
true to leave stream open when the stream is disposed.

LzmaStream(Stream, CompressionLevel, bool)

LzmaStream.cs

Initializes a new instance of the LzmaStream class that compresses at a compression level.

public LzmaStream(Stream stream, CompressionLevel compressionLevel, bool leaveOpen = false)
Parameters
stream Stream
The stream to write the compressed data to.
compressionLevel CompressionLevel
The compression level: CompressionLevel.Optimal is the preset 6, CompressionLevel.Fastest the preset 1, CompressionLevel.NoCompression the preset 0, and CompressionLevel.SmallestSize the preset 9.
leaveOpen bool
true to leave stream open when the stream is disposed.

LzmaStream(Stream, CompressionMode, bool)

LzmaStream.cs

Initializes 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
stream Stream
The stream to write the compressed data to, or to read it from.
mode CompressionMode
Whether to compress or decompress.
leaveOpen bool
true to leave stream open when the stream is disposed.

Properties

NameDescription
BaseStreamGets the stream that contains the compressed data.
CanReadWhen overridden in a derived class, gets a value indicating whether the current stream supports reading.
CanSeekWhen overridden in a derived class, gets a value indicating whether the current stream supports seeking.
CanWriteWhen overridden in a derived class, gets a value indicating whether the current stream supports writing.
LengthWhen overridden in a derived class, gets the length in bytes of the stream.
PositionWhen overridden in a derived class, gets or sets the position within the current stream.

BaseStream

LzmaStream.cs

Gets the stream that contains the compressed data.

public Stream BaseStream { get; }

Property value

Stream

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

public override bool CanRead { get; }

Property value

bool

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

public override bool CanSeek { get; }

Property value

bool

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

public override bool CanWrite { get; }

Property value

bool

When overridden in a derived class, gets the length in bytes of the stream.

public override long Length { get; }

Property value

long

Exceptions

NotSupportedException
A class derived from Stream does not support seeking and the length is unknown.
ObjectDisposedException
Methods were called after the stream was closed.

When overridden in a derived class, gets or sets the position within the current stream.

public override long Position { get; set; }

Property value

long

Exceptions

IOException
An I/O error occurs.
NotSupportedException
The stream does not support seeking.
ObjectDisposedException
Methods were called after the stream was closed.

Methods

NameDescription
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.cs

Asynchronously releases the unmanaged resources used by the Stream.

net10.0

public override ValueTask DisposeAsync()

net11.0

public override ValueTask DisposeAsync()

Returns

ValueTask A task that represents the asynchronous dispose operation.

When 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.cs

Asynchronously 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

cancellationToken CancellationToken
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.cs

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.

public override int Read(byte[] buffer, int offset, int count)
Parameters
buffer byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset int
The zero-based byte offset in buffer 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.
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 offset and count is larger than the buffer length.
ArgumentNullException
buffer is null.
ArgumentOutOfRangeException
offset or count is 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.cs

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.

public override int Read(Span<byte> buffer)
Parameters
buffer Span<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.cs

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.

public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
buffer byte[]
The buffer to write the data into.
offset int
The byte offset in buffer at which to begin writing data from the stream.
count int
The maximum number of bytes to read.
cancellationToken CancellationToken
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
ArgumentNullException
buffer is null.
ArgumentOutOfRangeException
offset or count is negative.
ArgumentException
The sum of offset and count is 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.cs

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.

public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)
Parameters
buffer Memory<byte>
The region of memory to write the data into.
cancellationToken CancellationToken
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.cs

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.

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.cs

When overridden in a derived class, sets the position within the current stream.

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long
A byte offset relative to the origin parameter.
origin SeekOrigin
A value of type SeekOrigin indicating 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.cs

When overridden in a derived class, sets the length of the current stream.

public override void SetLength(long value)

Parameters

value long
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.cs

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.

public override void Write(byte[] buffer, int offset, int count)
Parameters
buffer byte[]
An array of bytes. This method copies count bytes from buffer to the current stream.
offset int
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count int
The number of bytes to be written to the current stream.
Exceptions
ArgumentException
The sum of offset and count is greater than the buffer length.
ArgumentNullException
buffer is null.
ArgumentOutOfRangeException
offset or count is negative.
IOException
An I/O error occurred, such as the specified file cannot be found.
NotSupportedException
The stream does not support writing.
ObjectDisposedException
Stream.Write was called after the stream was closed.

Write(ReadOnlySpan<byte>)

LzmaStream.cs

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.

public override void Write(ReadOnlySpan<byte> buffer)
Parameters
buffer ReadOnlySpan<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.cs

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.

public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
buffer byte[]
The buffer to write data from.
offset int
The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count int
The maximum number of bytes to write.
cancellationToken CancellationToken
The token to monitor for cancellation requests. The default value is CancellationToken.None.
Returns

Task A task that represents the asynchronous write operation.

Exceptions
ArgumentNullException
buffer is null.
ArgumentOutOfRangeException
offset or count is negative.
ArgumentException
The sum of offset and count is 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.cs

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.

public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)
Parameters
buffer ReadOnlyMemory<byte>
The region of memory to write data from.
cancellationToken CancellationToken
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.cs

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

public override void WriteByte(byte value)

Parameters

value byte
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.