Skip to content

RefreshEnumerator

QuantConnect.Lean.Engine.DataFeeds.Enumerators.RefreshEnumerator

RefreshEnumerator(
    enumerator_factory: Callable[
        [],
        IEnumerator[
            QuantConnect_Lean_Engine_DataFeeds_Enumerators_RefreshEnumerator_T
        ],
    ],
)

Bases: Generic[QuantConnect_Lean_Engine_DataFeeds_Enumerators_RefreshEnumerator_T], Object, IEnumerator[QuantConnect_Lean_Engine_DataFeeds_Enumerators_RefreshEnumerator_T]

Provides an implementation of IEnumerator{T} that will always return true via MoveNext.

Initializes a new instance of the RefreshEnumerator{T} class

Parameters:

Name Type Description Default
enumerator_factory Callable[[], IEnumerator[QuantConnect_Lean_Engine_DataFeeds_Enumerators_RefreshEnumerator_T]]

Enumerator factory used to regenerate the underlying enumerator when it ends

required

current

current: QuantConnect_Lean_Engine_DataFeeds_Enumerators_RefreshEnumerator_T

Gets the element in the collection at the current position of the enumerator.

dispose

dispose() -> None

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

move_next

move_next() -> bool

Advances the enumerator to the next element of the collection.

Returns:

Type Description
bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

reset

reset() -> None

Sets the enumerator to its initial position, which is before the first element in the collection.