IChangeStreamCursor<TDocument> Interface |
Represents an asynchronous cursor for change stream.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic interface IChangeStreamCursor<out TDocument> : IAsyncCursor<TDocument>, IDisposable
Type Parameters
- TDocument
- The type of the document.
The IChangeStreamCursor<TDocument> type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Current |
Gets the current batch of documents.
(Inherited from IAsyncCursor<TDocument>.) |
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 IAsyncCursor<TDocument>.) |
| MoveNextAsync |
Moves to the next batch of documents.
(Inherited from IAsyncCursor<TDocument>.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Any<TDocument> |
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.) |
| AnyAsync<TDocument> |
Determines whether the cursor contains any documents.
(Defined by IAsyncCursorExtensions.) |
| First<TDocument> |
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.) |
| FirstAsync<TDocument> |
Returns the first document of a cursor.
(Defined by IAsyncCursorExtensions.) |
| FirstOrDefault<TDocument> |
Returns the first document of a cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.) |
| FirstOrDefaultAsync<TDocument> |
Returns the first document of the cursor, or a default value if the cursor contains no documents.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsync<TDocument>(Func<TDocument, Task>, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsync<TDocument>(Func<TDocument, Int32, Task>, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsync<TDocument>(Action<TDocument>, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| ForEachAsync<TDocument>(Action<TDocument, Int32>, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorExtensions.) |
| Single<TDocument> |
Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.
(Defined by IAsyncCursorExtensions.) |
| SingleAsync<TDocument> |
Returns the only document of a cursor. This method throws an exception if the cursor does not contain exactly one document.
(Defined by IAsyncCursorExtensions.) |
| SingleOrDefault<TDocument> |
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.) |
| SingleOrDefaultAsync<TDocument> |
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.) |
| ToEnumerable<TDocument> |
Wraps a cursor in an IEnumerable that can be enumerated one time.
(Defined by IAsyncCursorExtensions.) |
| ToList<TDocument> |
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.) |
| ToListAsync<TDocument> |
Returns a list containing all the documents returned by a cursor.
(Defined by IAsyncCursorExtensions.) |
See Also