Click or drag to resize

BatchTransformingAsyncCursor<TFromDocument, TToDocument> Class

Represents a cursor that wraps another cursor with a transformation function on the documents.
Inheritance Hierarchy
System.Object
  MongoDB.Driver.BatchTransformingAsyncCursor<TFromDocument, TToDocument>

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
Syntax
public sealed class BatchTransformingAsyncCursor<TFromDocument, TToDocument> : IAsyncCursor<TToDocument>, 
	IDisposable

Type Parameters

TFromDocument
The type of from document.
TToDocument
The type of to document.

The BatchTransformingAsyncCursor<TFromDocument, TToDocument> type exposes the following members.

Constructors
  NameDescription
Public methodBatchTransformingAsyncCursor<TFromDocument, TToDocument>
Initializes a new instance of the BatchTransformingAsyncCursor<TFromDocument, TToDocument> class.
Top
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.
Public methodEquals
Determines whether the specified object is equal to the current object.
(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.)
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 MethodAny<TToDocument>
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodAnyAsync<TToDocument>
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirst<TToDocument>
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstAsync<TToDocument>
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstOrDefault<TToDocument>
Returns the first document of a cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodFirstOrDefaultAsync<TToDocument>
Returns the first document of the cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TToDocument>(Func<TToDocument, Task>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TToDocument>(Func<TToDocument, Int32, Task>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TToDocument>(Action<TToDocument>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodForEachAsync<TToDocument>(Action<TToDocument, Int32>, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodSingle<TToDocument>
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<TToDocument>
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<TToDocument>
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<TToDocument>
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 MethodToEnumerable<TToDocument>
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 MethodToList<TToDocument>
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.)
Public Extension MethodToListAsync<TToDocument>
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.)
Top
See Also