MongoQueryableSingleAsyncTSource Method (IMongoQueryableTSource, CancellationToken) |
Returns the only element of a sequence, and throws an exception if there is not exactly one element in the sequence.
Namespace:
MongoDB.Driver.Linq
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax public static Task<TSource> SingleAsync<TSource>(
this IMongoQueryable<TSource> source,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function SingleAsync(Of TSource) (
source As IMongoQueryable(Of TSource),
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TSource)
[<ExtensionAttribute>]
static member SingleAsync :
source : IMongoQueryable<'TSource> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<'TSource>
Parameters
- source
- Type: MongoDB.Driver.LinqIMongoQueryableTSource
An IMongoQueryableT to return the single element of. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TSource
- The type of the elements of source.
Return Value
Type:
TaskTSource
The single element of the input sequence.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoQueryableTSource. 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