IAsyncCursorExtensions.ToEnumerable<TDocument> Method |
Wraps a cursor in an IEnumerable that can be enumerated one time.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntaxpublic static IEnumerable<TDocument> ToEnumerable<TDocument>(
this IAsyncCursor<TDocument> cursor,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function ToEnumerable(Of TDocument) (
cursor As IAsyncCursor(Of TDocument),
Optional cancellationToken As CancellationToken = Nothing
) As IEnumerable(Of TDocument)
[<ExtensionAttribute>]
static member ToEnumerable :
cursor : IAsyncCursor<'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> IEnumerable<'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:
IEnumerable<TDocument>An IEnumerable
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).
See Also