IAsyncCursorSourceExtensions.SingleAsync(TDocument) Method

IAsyncCursorSourceExtensionsSingleAsyncTDocument Method

Returns the only document of a cursor returned by a cursor source. 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.3.0

Syntax

Copy

public static Task<TDocument> SingleAsync<TDocument>(
	this IAsyncCursorSource<TDocument> source,
	CancellationToken cancellationToken = null
)

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

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

Parameters

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

Type Parameters

TDocument: The type of the document.

Return Value

Type: TaskTDocument
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 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).

Reference

IAsyncCursorSourceExtensions Class

MongoDB.Driver Namespace