BZip2Stream Class
Compresses or decompresses bzip2 data (.bz2), as GZipStream does for gzip. The decompression reads the concatenated streams of pbzip2 and lbzip2 and the randomized blocks of old versions of bzip2, checks the CRC of each block and of each stream, and throws an InvalidDataException for invalid data. The compression produces the data of bzip2, which ends when the stream is disposed.
public sealed class BZip2Stream : StreamExample
var data = "Hello, bzip2! Hello, bzip2!"u8.ToArray();
using var compressed = new MemoryStream();
using (var bzip2 = new BZip2Stream(compressed, new BZip2CompressionOptions { BlockSize = 9 }, leaveOpen: true))
{
bzip2.Write(data);
}
compressed.Position = 0;
using var decompress = new BZip2Stream(compressed, CompressionMode.Decompress);
using var result = new MemoryStream();
decompress.CopyTo(result);
Assert.Equal(data, result.ToArray());- Inheritance
StreamBZip2Stream
Constructors
| Name | Description |
|---|---|
| BZip2Stream(Stream, BZip2CompressionOptions, bool) | Initializes a new instance of the BZip2Stream class to compress a stream with options. |
| BZip2Stream(Stream, CompressionLevel, bool) | Initializes a new instance of the BZip2Stream class to compress a stream at a compression level. |
| BZip2Stream(Stream, CompressionMode, bool) | Initializes a new instance of the BZip2Stream class to compress or decompress a stream. |
BZip2Stream overloads
BZip2Stream(Stream, BZip2CompressionOptions, bool)
BZip2Stream.csInitializes a new instance of the BZip2Stream class to compress a stream with options.
public BZip2Stream(Stream stream, BZip2CompressionOptions options, bool leaveOpen = false)Parameters
streamStream- The stream to write the compressed data to.
optionsBZip2CompressionOptions- The options of the compression.
leaveOpenbool- Whether
streamstays open when this stream is disposed.
BZip2Stream(Stream, CompressionLevel, bool)
BZip2Stream.csInitializes a new instance of the BZip2Stream class to compress a stream at a compression level.
public BZip2Stream(Stream stream, CompressionLevel compressionLevel, bool leaveOpen = false)Parameters
streamStream- The stream to write the compressed data to.
compressionLevelCompressionLevel- The compression level:
CompressionLevel.FastestandCompressionLevel.NoCompressionuse blocks of 100 kB, the other levels use blocks of 900 kB. The data are always compressed. leaveOpenbool- Whether
streamstays open when this stream is disposed.
BZip2Stream(Stream, CompressionMode, bool)
BZip2Stream.csInitializes a new instance of the BZip2Stream class to compress or decompress a stream.
public BZip2Stream(Stream stream, CompressionMode mode, bool leaveOpen = false)Parameters
streamStream- The stream to read the compressed data from, or to write them to.
modeCompressionMode- Whether to compress (with the blocks of 900 kB of
bzip2 -9) or to decompress. leaveOpenbool- Whether
streamstays open when this stream is disposed.
Properties
| Name | Description |
|---|---|
| BaseStream | Gets the stream the compressed data are read from or written to. |
| 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
BZip2Stream.csCanRead
BZip2Stream.csCanSeek
BZip2Stream.csCanWrite
BZip2Stream.csLength
BZip2Stream.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
BZip2Stream.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() | Does nothing: a bzip2 block is written when it is full, or when the stream is disposed. |
| 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. |
Flush()
BZip2Stream.csDoes nothing: a bzip2 block is written when it is full, or when the stream is disposed.
public override void Flush()Read overloads
Read(byte[], int, int)
BZip2Stream.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>)
BZip2Stream.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)
BZip2Stream.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)
BZip2Stream.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()
BZip2Stream.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)
BZip2Stream.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)
BZip2Stream.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)
BZip2Stream.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>)
BZip2Stream.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)
BZip2Stream.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)
BZip2Stream.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)
BZip2Stream.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.