AsyncCursorTDocument Class

Represents an async cursor.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.Core.OperationsAsyncCursorTDocument

Namespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

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

Public Class AsyncCursor(Of TDocument)
	Implements IAsyncCursor(Of TDocument), IDisposable

type AsyncCursor<'TDocument> =  
    class
        interface IAsyncCursor<'TDocument>
        interface IDisposable
    end

Type Parameters

TDocument: The type of the documents.

The AsyncCursorTDocument type exposes the following members.

Constructors

	Name	Description
	AsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonDocument, IReadOnlyListTDocument, Int64, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan)	Obsolete. Initializes a new instance of the AsyncCursorTDocument class.
	AsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonValue, IReadOnlyListTDocument, Int64, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan)	Initializes a new instance of the AsyncCursorTDocument class.
	AsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonDocument, IReadOnlyListTDocument, Int64, BsonDocument, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan)	Obsolete. Initializes a new instance of the AsyncCursorTDocument class.
	AsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonValue, IReadOnlyListTDocument, Int64, BsonDocument, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan)	Initializes a new instance of the AsyncCursorTDocument class.

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	Close	Closes the cursor.
	CloseAsync	Closes the cursor.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Dispose(Boolean)	Releases unmanaged and - optionally - managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveNext	Moves to the next batch of documents.
	MoveNextAsync	Moves to the next batch of documents.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	AnyTDocument	Determines whether the cursor contains any documents. (Defined by IAsyncCursorExtensions.)
	AnyAsyncTDocument	Determines whether the cursor contains any documents. (Defined by IAsyncCursorExtensions.)
	FirstTDocument	Returns the first document of a cursor. (Defined by IAsyncCursorExtensions.)
	FirstAsyncTDocument	Returns the first document of a cursor. (Defined by IAsyncCursorExtensions.)
	FirstOrDefaultTDocument	Returns the first document of a cursor, or a default value if the cursor contains no documents. (Defined by IAsyncCursorExtensions.)
	FirstOrDefaultAsyncTDocument	Returns the first document of the cursor, or a default value if the cursor contains no documents. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTDocument(FuncTDocument, Task, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTDocument(FuncTDocument, Int32, Task, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTDocument(ActionTDocument, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTDocument(ActionTDocument, Int32, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	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.)
	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.)
	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.)
	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.)
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToEnumerableTDocument	Wraps a cursor in an IEnumerable that can be enumerated one time. (Defined by IAsyncCursorExtensions.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)
	ToListTDocument	Returns a list containing all the documents returned by a cursor. (Defined by IAsyncCursorExtensions.)
	ToListAsyncTDocument	Returns a list containing all the documents returned by a cursor. (Defined by IAsyncCursorExtensions.)

Top

Reference

MongoDB.Driver.Core.Operations Namespace

AsyncCursorAddLanguageSpecificTextSet("LSTC92BB592_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TDocumentAddLanguageSpecificTextSet("LSTC92BB592_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

AsyncCursorTDocument Class