BatchableSource(T) Class

BatchableSourceT Class

Represents a source of items that can be broken into batches.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.Core.MiscBatchableSourceT

Namespace: MongoDB.Driver.Core.Misc
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.0.1

Syntax

public sealed class BatchableSource<T>

Public NotInheritable Class BatchableSource(Of T)

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

The BatchableSourceT type exposes the following members.

Constructors

	Name	Description
	BatchableSourceT(IEnumerableT)	Initializes a new instance of the BatchableSourceT class.
	BatchableSourceT(IEnumeratorT)	Initializes a new instance of the BatchableSourceT class.

Methods

	Name	Description
	ClearBatch	Clears the most recent batch.
	EndBatch(IReadOnlyListT)	Called when the last batch is complete.
	EndBatch(IReadOnlyListT, BatchableSourceTOverflow)	Called when an intermediate batch is complete.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRemainingItems	Gets all the remaining items that haven't been previously consumed.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MoveNext	Moves to the next item in the source.
	StartBatch	Starts a new batch.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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.)

Properties

	Name	Description
	Batch	Gets the most recent batch.
	Current	Gets the current item.
	HasMore	Gets a value indicating whether there are more items.