Method ReadAsync
| MongoDB CSharp Driver API Reference (original) (raw)
Namespace
Assembly
MongoDB.Driver.dll
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.
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 None.
Returns
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 the end of the stream has been reached.
Exceptions
buffer is null.
offset or count is negative.
The sum of offset and count is larger than the buffer length.
The stream does not support reading.
The stream has been disposed.
The stream is currently in use by a previous read operation.