Click or drag to resize

IAsyncCursorExtensionsSingleTDocument 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.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax
public static TDocument Single<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: TDocument
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