Class BatchTransformingAsyncCursor<TFromDocument, TToDocument>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.Core.dll

Represents a cursor that wraps another cursor with a transformation function on the documents.

public sealed class BatchTransformingAsyncCursor<TFromDocument, TToDocument> : IAsyncCursor<TToDocument>, IDisposable

Type Parameters

TFromDocument

The type of from document.

TToDocument

The type of to document.

Inheritance

object

BatchTransformingAsyncCursor<TFromDocument, TToDocument>

Implements

IAsyncCursor<TToDocument>

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IAsyncCursorExtensions.AnyAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.Any<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.FirstAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.FirstOrDefaultAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.FirstOrDefault<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.First<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Action<TDocument, int>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Action<TDocument>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Func<TDocument, int, Task>, CancellationToken)

IAsyncCursorExtensions.ForEachAsync<TDocument>(IAsyncCursor<TDocument>, Func<TDocument, Task>, CancellationToken)

IAsyncCursorExtensions.SingleAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.SingleOrDefaultAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.SingleOrDefault<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.Single<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ToEnumerable<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ToListAsync<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

IAsyncCursorExtensions.ToList<TDocument>(IAsyncCursor<TDocument>, CancellationToken)

Constructors

BatchTransformingAsyncCursor(IAsyncCursor<TFromDocument>, Func<IEnumerable<TFromDocument>, IEnumerable<TToDocument>>)

Initializes a new instance of the BatchTransformingAsyncCursor<TFromDocument, TToDocument> class.

public BatchTransformingAsyncCursor(IAsyncCursor<TFromDocument> wrapped, Func<IEnumerable<TFromDocument>, IEnumerable<TToDocument>> transformer)

Parameters

wrapped IAsyncCursor<TFromDocument>

The wrapped.

transformer Func<IEnumerable<TFromDocument>, IEnumerable<TToDocument>>

The transformer.

See Also

IAsyncCursor<TDocument>

Properties

Current

Gets the current batch of documents.

public IEnumerable<TToDocument> Current { get; }

Property Value

IEnumerable<TToDocument>

The current batch of documents.

See Also

IAsyncCursor<TDocument>

Methods

Dispose()

public void Dispose()

See Also

IAsyncCursor<TDocument>

MoveNext(CancellationToken)

Moves to the next batch of documents.

public bool MoveNext(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

bool

Whether any more documents are available.

See Also

IAsyncCursor<TDocument>

MoveNextAsync(CancellationToken)

Moves to the next batch of documents.

public Task<bool> MoveNextAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<bool>

A Task whose result indicates whether any more documents are available.

See Also

IAsyncCursor<TDocument>

See Also

IAsyncCursor<TDocument>