Class BatchableSource<T>

Namespace: MongoDB.Driver.Core.Misc

Assembly: MongoDB.Driver.Core.dll

Represents a batch of items that can be split if not all items can be processed at once.

public sealed class BatchableSource<T> : IBatchableSource<T>

Type Parameters

T: The type of the items.

Inheritance: object

BatchableSource<T>

Implements: IBatchableSource<T>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BatchableSource(IEnumerable<T>): Initializes a new instance of the BatchableSource<T> class.

BatchableSource(IEnumerator<T>): Initializes a new instance of the BatchableSource<T> class.

BatchableSource(IReadOnlyList<T>, bool): Initializes a new instance of the BatchableSource<T> class.

BatchableSource(IReadOnlyList<T>, int, int, bool): Initializes a new instance of the BatchableSource<T> class.

Properties

AllItemsWereProcessed: Gets a value indicating whether all items were processed.

CanBeSplit: Gets a value indicating whether the batch can be split.

Count: Gets the count.

Items: Gets the items.

Offset: Gets the offset.

ProcessedCount: Gets the count of processed items. Equal to zero until SetProcessedCount has been called.

Methods

AdvancePastProcessedItems(): Advances past the processed items.

GetBatchItems(): Gets the items in the batch.

GetProcessedItems(): Gets the items that were processed.

GetUnprocessedItems(): Gets the items that were not processed.

SetProcessedCount(int): Sets the processed count.