Click or drag to resize

IAsyncCursorTDocument Interface

Represents an asynchronous cursor.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax
public interface IAsyncCursor<out TDocument> : IDisposable

Type Parameters

TDocument
The type of the document.

The IAsyncCursorTDocument 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 MethodAnyTDocument
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodAnyAsyncTDocument
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstTDocument
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstAsyncTDocument
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstOrDefaultTDocument
Returns the first document of a cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstOrDefaultAsyncTDocument
Returns the first document of the cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsyncTDocument(FuncTDocument, Task, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsyncTDocument(FuncTDocument, Int32, Task, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsyncTDocument(ActionTDocument, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsyncTDocument(ActionTDocument, Int32, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodSingleTDocument
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 MethodSingleAsyncTDocument
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 MethodSingleOrDefaultTDocument
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 MethodSingleOrDefaultAsyncTDocument
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 MethodToEnumerableTDocument
Wraps a cursor in an IEnumerable that can be enumerated one time.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToListTDocument
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToListAsyncTDocument
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.)
Top
See Also