Click or drag to resize

IAsyncCursorExtensionsSingleAsyncTDocument 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.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax
public static Task<TDocument> SingleAsync<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = default
)

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: 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 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).
See Also