Click or drag to resize

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
public class AsyncCursor<TDocument> : IAsyncCursor<TDocument>, 
	IDisposable

Type Parameters

TDocument
The type of the documents.

The AsyncCursorTDocument type exposes the following members.

Constructors
  NameDescription
Public methodAsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonDocument, IReadOnlyListTDocument, Int64, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan) Obsolete.
Initializes a new instance of the AsyncCursorTDocument class.
Public methodAsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonValue, IReadOnlyListTDocument, Int64, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan)
Initializes a new instance of the AsyncCursorTDocument class.
Public methodAsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonDocument, IReadOnlyListTDocument, Int64, BsonDocument, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan) Obsolete.
Initializes a new instance of the AsyncCursorTDocument class.
Public methodAsyncCursorTDocument(IChannelSource, CollectionNamespace, BsonValue, IReadOnlyListTDocument, Int64, BsonDocument, NullableInt32, NullableInt32, IBsonSerializerTDocument, MessageEncoderSettings, NullableTimeSpan)
Initializes a new instance of the AsyncCursorTDocument class.
Top
Properties
  NameDescription
Public propertyCurrent
Gets the current batch of documents.
Public propertyPostBatchResumeToken
Gets the post batch resume token.
Public propertyWasFirstBatchEmpty
Gets a value indicating whether the first batch was empty or not.
Top
Methods
  NameDescription
Public methodClose
Closes the cursor.
Public methodCloseAsync
Closes the cursor.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveNext
Moves to the next batch of documents.
Public methodMoveNextAsync
Moves to the next batch of documents.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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 MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToEnumerableTDocument
Wraps a cursor in an IEnumerable that can be enumerated one time.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
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