UnmanagedMemoryStream.WriteAsync Method

Definition

Namespace:

System.IO

Assemblies:

netstandard.dll, System.Runtime.dll

Overloads

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronously writes a span of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
WriteAsync(Byte[], Int32, Int32, 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)

Source:

UnmanagedMemoryStream.cs

Asynchronously writes a span of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

C#

public override System.Threading.Tasks.ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

Parameters

buffer

ReadOnlyMemory<Byte>

The buffer to write data from.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is 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.

Remarks

If an exception occurs during the write operation, it will be set as the Task.Exception of the property of the returned task.

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

Source:

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

C#

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

Parameters

buffer

Byte[]

The buffer to write data from.

offset

Int32

The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count

Int32

The maximum number of bytes to write.

cancellationToken

CancellationToken

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

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

OperationCanceledException

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

Remarks

If an exception occurs during the write operation, it will be set as the Task.Exception of the property of the returned task.

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 Write(Byte[], Int32, Int32).