Click or drag to resize

IAsyncCursor<TDocument> Interface

Represents an asynchronous cursor.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public interface IAsyncCursor<out TDocument> : IDisposable

Type Parameters

TDocument
The type of the document.

The IAsyncCursor<TDocument> type exposes the following members.

Properties
  NameDescription
Public propertyCurrent
Gets the current batch of documents.
Top
Methods
  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodMoveNext
Moves to the next batch of documents.
Public methodMoveNextAsync
Moves to the next batch of documents.
Top
Extension Methods
  NameDescription
Public Extension MethodAny<TDocument>
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodAnyAsync<TDocument>
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirst<TDocument>
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstAsync<TDocument>
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstOrDefault<TDocument>
Returns the first document of a cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstOrDefaultAsync<TDocument>
Returns the first document of the cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TDocument>(Func<TDocument, Task>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TDocument>(Func<TDocument, Int32, Task>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TDocument>(Action<TDocument>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TDocument>(Action<TDocument, Int32>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodSingle<TDocument>
Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodSingleAsync<TDocument>
Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodSingleOrDefault<TDocument>
Returns the only document of a cursor, or a default value if the cursor contains no documents. This method throws an exception if the cursor contains more than one document.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodSingleOrDefaultAsync<TDocument>
Returns the only document of a cursor, or a default value if the cursor contains no documents. This method throws an exception if the cursor contains more than one document.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToEnumerable<TDocument>
Wraps a cursor in an IEnumerable that can be enumerated one time.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToList<TDocument>
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToListAsync<TDocument>
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.)
Top
See Also