Click or drag to resize

BatchableSourceT Class

Represents a batch of items that can be split if not all items can be processed at once.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.Core.MiscBatchableSourceT

Namespace:  MongoDB.Driver.Core.Misc
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax
Copy
public sealed class BatchableSource<T>

Type Parameters

T
The type of the items.

The BatchableSourceT type exposes the following members.

Constructors
  NameDescription
Public methodBatchableSourceT(IEnumerableT) Obsolete.
Initializes a new instance of the BatchableSourceT class.
Public methodBatchableSourceT(IEnumeratorT) Obsolete.
Initializes a new instance of the BatchableSourceT class.
Public methodBatchableSourceT(IReadOnlyListT, Boolean)
Initializes a new instance of the BatchableSourceT class.
Public methodBatchableSourceT(IReadOnlyListT, Int32, Int32, Boolean)
Initializes a new instance of the BatchableSourceT class.
Top
Properties
  NameDescription
Public propertyAllItemsWereProcessed
Gets a value indicating whether all items were processed.
Public propertyCanBeSplit
Gets a value indicating whether the batch can be split.
Public propertyCount
Gets the count.
Public propertyItems
Gets the items.
Public propertyOffset
Gets the offset.
Public propertyProcessedCount
Gets the count of processed items. Equal to zero until SetProcessedCount has been called.
Top
Methods
  NameDescription
Public methodAdvancePastProcessedItems
Advances past the processed items.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetBatchItems
Gets the items in the batch.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetProcessedItems
Gets the items that were processed.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUnprocessedItems
Gets the items that were not processed.
Public methodSetProcessedCount
Sets the processed count.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also