IAsyncCursorExtensionsToListAsyncTDocument Method

Returns a list containing all the documents returned by a cursor.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2

Syntax

Copy

public static Task<List<TDocument>> ToListAsync<TDocument>(
	this IAsyncCursor<TDocument> source,
	CancellationToken cancellationToken = default
)

<ExtensionAttribute>
Public Shared Function ToListAsync(Of TDocument) ( 
	source As IAsyncCursor(Of TDocument),
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of List(Of TDocument))

[<ExtensionAttribute>]
static member ToListAsync : 
        source : IAsyncCursor<'TDocument> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<List<'TDocument>>

Parameters

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

Type Parameters

TDocument: The type of the document.

Return Value

Type: TaskListTDocument
A Task whose value is the list of documents.

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