Click or drag to resize

IAsyncCursorSourceExtensionsForEachAsyncTDocument Method (IAsyncCursorSourceTDocument, ActionTDocument, Int32, CancellationToken)

Calls a delegate for each document returned by the cursor.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
public static Task ForEachAsync<TDocument>(
	this IAsyncCursorSource<TDocument> source,
	Action<TDocument, int> processor,
	CancellationToken cancellationToken = default
)

Parameters

source
Type: MongoDB.DriverIAsyncCursorSourceTDocument
The source.
processor
Type: SystemActionTDocument, Int32
The processor.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: Task
A Task that completes when all the documents have been processed.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncCursorSourceTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
If your delegate is going to take a long time to execute or is going to block consider using a different overload of ForEachAsync that uses a delegate that returns a Task instead.
See Also