BsonStreamAdapter.CopyToAsync Method (Stream, Int32, CancellationToken)

BsonStreamAdapterCopyToAsync Method (Stream, Int32, CancellationToken)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

Namespace: MongoDB.Bson.IO
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.4.1

Syntax

Copy

public override Task CopyToAsync(
	Stream destination,
	int bufferSize,
	CancellationToken cancellationToken
)

Public Overrides Function CopyToAsync ( 
	destination As Stream,
	bufferSize As Integer,
	cancellationToken As CancellationToken
) As Task

abstract CopyToAsync : 
        destination : Stream * 
        bufferSize : int * 
        cancellationToken : CancellationToken -> Task 
override CopyToAsync : 
        destination : Stream * 
        bufferSize : int * 
        cancellationToken : CancellationToken -> Task

Parameters

destination: Type: System.IOStream
The stream to which the contents of the current stream will be copied.
bufferSize: Type: SystemInt32
The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.
cancellationToken: Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests. The default value is None.

Return Value

Type: Task
A task that represents the asynchronous copy operation.

Exceptions

Exception	Condition
ArgumentNullException	destination is null.
ArgumentOutOfRangeException	buffersize is negative or zero.
ObjectDisposedException	Either the current stream or the destination stream is disposed.
NotSupportedException	The current stream does not support reading, or the destination stream does not support writing.

Reference

BsonStreamAdapter Class

CopyToAsync Overload

MongoDB.Bson.IO Namespace