Class AsyncCursor<TDocument>

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

Represents an async cursor.

public class AsyncCursor<TDocument> : IAsyncCursor<TDocument>, IDisposable

Type Parameters

TDocument

The type of the documents.

Inheritance

object

AsyncCursor<TDocument>

Implements

IAsyncCursor<TDocument>

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IAsyncCursorExtensions.AnyAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.Any<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.FirstAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.FirstOrDefaultAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.FirstOrDefault<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.First<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Action<TDocument, int>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Action<TDocument>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Func<TDocument, int, Task>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Func<TDocument, Task>, CancellationToken)

IAsyncCursorExtensions.SingleAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.SingleOrDefaultAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.SingleOrDefault<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.Single<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ToEnumerable<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ToListAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ToList<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

Constructors

AsyncCursor(IChannelSource, CollectionNamespace, BsonDocument, IReadOnlyList<TDocument>, long, BsonDocument, int?, int?, IBsonSerializer<TDocument>, MessageEncoderSettings, TimeSpan?)

Initializes a new instance of the AsyncCursor<TDocument> class.

AsyncCursor(IChannelSource, CollectionNamespace, BsonDocument, IReadOnlyList<TDocument>, long, int?, int?, IBsonSerializer<TDocument>, MessageEncoderSettings, TimeSpan?)

Initializes a new instance of the AsyncCursor<TDocument> class.

AsyncCursor(IChannelSource, CollectionNamespace, BsonValue, IReadOnlyList<TDocument>, long, BsonDocument, int?, int?, IBsonSerializer<TDocument>, MessageEncoderSettings, TimeSpan?)

Initializes a new instance of the AsyncCursor<TDocument> class.

AsyncCursor(IChannelSource, CollectionNamespace, BsonValue, IReadOnlyList<TDocument>, long, int?, int?, IBsonSerializer<TDocument>, MessageEncoderSettings, TimeSpan?)

Initializes a new instance of the AsyncCursor<TDocument> class.

Properties

Current

Gets the current batch of documents.

PostBatchResumeToken

Gets the post batch resume token.

WasFirstBatchEmpty

Gets a value indicating whether the first batch was empty or not.

Methods

Close(CancellationToken)

Closes the cursor.

CloseAsync(CancellationToken)

Closes the cursor.

Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

MoveNext(CancellationToken)

Moves to the next batch of documents.

MoveNextAsync(CancellationToken)

Moves to the next batch of documents.