Table of Contents

Class DeferredAsyncCursor<TDocument>

Namespace
MongoDB.Driver
Assembly
MongoDB.Driver.Core.dll

Represents a cursor for an operation that is not actually executed until MoveNextAsync is called for the first time.

public sealed class DeferredAsyncCursor<TDocument> : IAsyncCursor<TDocument>, IDisposable

Type Parameters

TDocument

The type of the document.

Inheritance
DeferredAsyncCursor<TDocument>
Implements
IAsyncCursor<TDocument>
Inherited Members
Extension Methods

Constructors

DeferredAsyncCursor(Action, Func<CancellationToken, IAsyncCursor<TDocument>>, Func<CancellationToken, Task<IAsyncCursor<TDocument>>>)

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

public DeferredAsyncCursor(Action disposeAction, Func<CancellationToken, IAsyncCursor<TDocument>> execute, Func<CancellationToken, Task<IAsyncCursor<TDocument>>> executeAsync)

Parameters

disposeAction Action

The dispose action.

execute Func<CancellationToken, IAsyncCursor<TDocument>>

The delegate to execute the first time MoveNext is called.

executeAsync Func<CancellationToken, Task<IAsyncCursor<TDocument>>>

The delegate to execute the first time MoveNextAsync is called.

Properties

Current

Gets the current batch of documents.

public IEnumerable<TDocument> Current { get; }

Property Value

IEnumerable<TDocument>

The current batch of documents.

Methods

Dispose() 

public void Dispose()

MoveNext(CancellationToken)

Moves to the next batch of documents.

public bool MoveNext(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

bool

Whether any more documents are available.

MoveNextAsync(CancellationToken)

Moves to the next batch of documents.

public Task<bool> MoveNextAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<bool>

A Task whose result indicates whether any more documents are available.