IAsyncCursorExtensions.SingleAsync<TDocument> Method

Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.

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

Syntax

Copy

public static Task<TDocument> SingleAsync<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = null
)

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

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

Parameters

cursor: Type: MongoDB.Driver.IAsyncCursor<TDocument>
The cursor.
cancellationToken (Optional): Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TDocument: The type of the document.

Return Value

Type: Task<TDocument>
A Task whose result is the only document of a cursor.

Usage Note

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