IChangeStreamCursorTDocument Interface |
Represents an asynchronous cursor for change stream.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntaxpublic interface IChangeStreamCursor<out TDocument> : IAsyncCursor<TDocument>, IDisposable
Type Parameters
- TDocument
- The type of the document.
The IChangeStreamCursorTDocument type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Current |
Gets the current batch of documents.
(Inherited from IAsyncCursorTDocument.) |
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| GetResumeToken |
Gets the resume token.
|
| MoveNext |
Moves to the next batch of documents.
(Inherited from IAsyncCursorTDocument.) |
| MoveNextAsync |
Moves to the next batch of documents.
(Inherited from IAsyncCursorTDocument.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AnyTDocument |
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.) |
| AnyAsyncTDocument |
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.) |
| FirstTDocument |
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.) |
| FirstAsyncTDocument |
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.) |
| FirstOrDefaultTDocument |
Returns the first document of a cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.) |
| FirstOrDefaultAsyncTDocument |
Returns the first document of the cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsyncTDocument(FuncTDocument, Task, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsyncTDocument(FuncTDocument, Int32, Task, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsyncTDocument(ActionTDocument, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsyncTDocument(ActionTDocument, Int32, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| SingleTDocument |
Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.
(Defined by IAsyncCursorExtensions.) |
| SingleAsyncTDocument |
Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.
(Defined by IAsyncCursorExtensions.) |
| SingleOrDefaultTDocument |
Returns the only document of a cursor, or a default value if the cursor contains no documents.
This method throws an exception if the cursor contains more than one document.
(Defined by IAsyncCursorExtensions.) |
| SingleOrDefaultAsyncTDocument |
Returns the only document of a cursor, or a default value if the cursor contains no documents.
This method throws an exception if the cursor contains more than one document.
(Defined by IAsyncCursorExtensions.) |
| ToEnumerableTDocument |
Wraps a cursor in an IEnumerable that can be enumerated one time.
(Defined by IAsyncCursorExtensions.) |
| ToListTDocument |
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.) |
| ToListAsyncTDocument |
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.) |
See Also