GZipStream.ReadAsync Method

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.dll

Overloads

ReadAsync(Memory<Byte>, CancellationToken)	Asynchronously reads a sequence of bytes from the current GZip stream into a byte memory region, advances the position within the GZip stream by the number of bytes read, and monitors cancellation requests.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously reads a sequence of bytes from the current GZip stream into a byte array, advances the position within the GZip stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken)

Source:

GZipStream.cs

Asynchronously reads a sequence of bytes from the current GZip stream into a byte memory region, advances the position within the GZip stream by the number of bytes read, and monitors cancellation requests.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

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

Returns

ValueTask<Int32>

A task that represents the asynchronous read operation, which wraps the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the GZip stream has been reached.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

Important

Starting in .NET 6, this method might not read as many bytes as were requested. For more information, see Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream.

The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in desktop apps where a time-consuming stream operation can block the UI thread and make the app appear as if it's not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use the CanRead property to determine whether the current instance supports reading.

If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Source:

GZipStream.cs

Asynchronously reads a sequence of bytes from the current GZip stream into a byte array, advances the position within the GZip stream by the number of bytes read, and monitors cancellation requests.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parameters

buffer

Byte[]

The buffer to write the data into.

offset

Int32

The byte offset at which to begin writing data from the GZip stream.

count

Int32

The maximum number of bytes to read.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task<Int32>

A task that represents the asynchronous read operation, which wraps the total number of bytes read. 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 the end of the GZip stream has been reached.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

Important

Starting in .NET 6, this method might not read as many bytes as were requested. For more information, see Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream.

The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in desktop apps where a time-consuming stream operation can block the UI thread and make the app appear as if it's not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use the CanRead property to determine whether the current instance supports reading.

If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Read(Byte[], Int32, Int32).