IAsyncCursorExtensionsToEnumerableTDocument Method

Wraps a cursor in an IEnumerable that can be enumerated one time.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

Copy

public static IEnumerable<TDocument> ToEnumerable<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = null
)

<ExtensionAttribute>
Public Shared Function ToEnumerable(Of TDocument) ( 
	cursor As IAsyncCursor(Of TDocument),
	Optional cancellationToken As CancellationToken = Nothing
) As IEnumerable(Of TDocument)

[<ExtensionAttribute>]
static member ToEnumerable : 
        cursor : IAsyncCursor<'TDocument> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> IEnumerable<'TDocument>

Parameters

cursor: Type: MongoDB.DriverIAsyncCursorTDocument
The cursor.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument: The type of the document.

Return Value

Type: IEnumerableTDocument
An IEnumerable

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncCursorTDocument. 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).

Reference

IAsyncCursorExtensions Class