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.13.1-v2-13-x1+a7f8afe27855f38f4f72157d11ba2ae73895502e

Syntax

Copy

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

Public NotInheritable Class BatchableSource(Of T)
	Implements IBatchableSource(Of T)

[<SealedAttribute>]
type BatchableSource<'T> =  
    class
        interface IBatchableSource<'T>
    end

Type Parameters

T: The type of the items.

The BatchableSourceT type exposes the following members.

Constructors

	Name	Description
	BatchableSourceT(IEnumerableT)	Obsolete. Initializes a new instance of the BatchableSourceT class.
	BatchableSourceT(IEnumeratorT)	Obsolete. Initializes a new instance of the BatchableSourceT class.
	BatchableSourceT(IReadOnlyListT, Boolean)	Initializes a new instance of the BatchableSourceT class.
	BatchableSourceT(IReadOnlyListT, Int32, Int32, Boolean)	Initializes a new instance of the BatchableSourceT class.

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	AdvancePastProcessedItems	Advances past the processed items.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetBatchItems	Gets the items in the batch.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetProcessedItems	Gets the items that were processed.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnprocessedItems	Gets the items that were not processed.
	SetProcessedCount	Sets the processed count.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Core.Misc Namespace

BatchableSourceAddLanguageSpecificTextSet("LST21D0192F_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TAddLanguageSpecificTextSet("LST21D0192F_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

BatchableSourceT Class