IAsyncCursor(TDocument) Interface (original) (raw)

IAsyncCursorTDocument Interface

Represents an asynchronous cursor.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

public interface IAsyncCursor : IDisposable

Public Interface IAsyncCursor(Of Out TDocument) Inherits IDisposable

type IAsyncCursor<'TDocument> =
interface interface IDisposable end

Type Parameters

TDocument

The type of the document.

The IAsyncCursorTDocument type exposes the following members.

Properties

| | Name | Description | | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------ | | Public property | Current | Gets the current batch of documents. |

Top

Methods

| | Name | Description | | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Public method | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | | Public method | MoveNext | Moves to the next batch of documents. | | Public method | MoveNextAsync | Moves to the next batch of documents. |

Top

Extension Methods

| | Name | Description | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Public Extension Method | AnyTDocument | Determines whether the cursor contains any documents. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | AnyAsyncTDocument | Determines whether the cursor contains any documents. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | FirstTDocument | Returns the first document of a cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | FirstAsyncTDocument | Returns the first document of a cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | FirstOrDefaultTDocument | Returns the first document of a cursor, or a default value if the cursor contains no documents. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | FirstOrDefaultAsyncTDocument | Returns the first document of the cursor, or a default value if the cursor contains no documents. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | ForEachAsyncTDocument(FuncTDocument, Task, CancellationToken) | Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | ForEachAsyncTDocument(FuncTDocument, Int32, Task, CancellationToken) | Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | ForEachAsyncTDocument(ActionTDocument, CancellationToken) | Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | ForEachAsyncTDocument(ActionTDocument, Int32, CancellationToken) | Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | SingleTDocument | 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 Method | SingleAsyncTDocument | 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 Method | SingleOrDefaultTDocument | 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 Method | SingleOrDefaultAsyncTDocument | 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 Method | ToEnumerableTDocument | Wraps a cursor in an IEnumerable that can be enumerated one time. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | ToListTDocument | Returns a list containing all the documents returned by a cursor. (Defined by IAsyncCursorExtensions.) | | Public Extension Method | ToListAsyncTDocument | Returns a list containing all the documents returned by a cursor. (Defined by IAsyncCursorExtensions.) |

Top

See Also

Reference