BatchTransformingAsyncCursorTFromDocument, TToDocument Class

Represents a cursor that wraps another cursor with a transformation function on the documents.

Inheritance Hierarchy

SystemObject
MongoDB.DriverBatchTransformingAsyncCursorTFromDocument, TToDocument

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public sealed class BatchTransformingAsyncCursor<TFromDocument, TToDocument> : IAsyncCursor<TToDocument>, 
	IDisposable

Public NotInheritable Class BatchTransformingAsyncCursor(Of TFromDocument, TToDocument)
	Implements IAsyncCursor(Of TToDocument), IDisposable

[<SealedAttribute>]
type BatchTransformingAsyncCursor<'TFromDocument, 'TToDocument> =  
    class
        interface IAsyncCursor<'TToDocument>
        interface IDisposable
    end

Type Parameters

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

The BatchTransformingAsyncCursorTFromDocument, TToDocument type exposes the following members.

Constructors

	Name	Description
	BatchTransformingAsyncCursorTFromDocument, TToDocument	Initializes a new instance of the BatchTransformingAsyncCursorTFromDocument, TToDocument class.

Top

Properties

	Name	Description
	Current	Gets the current batch of documents.

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (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
	AnyTToDocument	Determines whether the cursor contains any documents. (Defined by IAsyncCursorExtensions.)
	AnyAsyncTToDocument	Determines whether the cursor contains any documents. (Defined by IAsyncCursorExtensions.)
	FirstTToDocument	Returns the first document of a cursor. (Defined by IAsyncCursorExtensions.)
	FirstAsyncTToDocument	Returns the first document of a cursor. (Defined by IAsyncCursorExtensions.)
	FirstOrDefaultTToDocument	Returns the first document of a cursor, or a default value if the cursor contains no documents. (Defined by IAsyncCursorExtensions.)
	FirstOrDefaultAsyncTToDocument	Returns the first document of the cursor, or a default value if the cursor contains no documents. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTToDocument(FuncTToDocument, Task, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTToDocument(FuncTToDocument, Int32, Task, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTToDocument(ActionTToDocument, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	ForEachAsyncTToDocument(ActionTToDocument, Int32, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorExtensions.)
	SingleTToDocument	Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document. (Defined by IAsyncCursorExtensions.)
	SingleAsyncTToDocument	Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document. (Defined by IAsyncCursorExtensions.)
	SingleOrDefaultTToDocument	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.)
	SingleOrDefaultAsyncTToDocument	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.)
	ToEnumerableTToDocument	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.)
	ToListTToDocument	Returns a list containing all the documents returned by a cursor. (Defined by IAsyncCursorExtensions.)
	ToListAsyncTToDocument	Returns a list containing all the documents returned by a cursor. (Defined by IAsyncCursorExtensions.)

Top

Reference

MongoDB.Driver Namespace

MongoDB.DriverIAsyncCursorTDocument

BatchTransformingAsyncCursorAddLanguageSpecificTextSet("LST349EBE5C_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TFromDocument, TToDocumentAddLanguageSpecificTextSet("LST349EBE5C_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

BatchTransformingAsyncCursorTFromDocument, TToDocument Class