package @rimbu/stream/custom

The @rimbu/stream/custom entry exposes custom constructors, fast iterator helpers and internal stream implementations that underlie the main Stream API in @rimbu/stream. It is intended for advanced scenarios where you need to build specialized stream sources or integrate with the fast‑iterator infrastructure; for most use cases the main @rimbu/stream entry is sufficient.

Interfaces

Name	Description
StreamConstructors	An interface describing all factory functions used to create Stream instances. Implementations of this interface are exposed via the global Stream value and the @rimbu/stream/custom sub-package.

Classes

Name	Description
AlwaysIterator	undocumented
AppendIterator	undocumented
ArrayIterator_2	undocumented
ArrayReverseIterator	undocumented
CollectIterator	undocumented
ConcatIterator	undocumented
DropIterator	undocumented
DropWhileIterator	undocumented
FastIteratorBase	A base class for FastIterator instances that implements the standard next method in terms of the abstract fastNext method.
FilterApplyIterator	undocumented
FilterIterator	undocumented
FilterPureIterator	undocumented
IndexedIterator	undocumented
MapApplyIterator	undocumented
MapIterator_2	undocumented
MapPureIterator	undocumented
PrependIterator	undocumented
RandomIntIterator	undocumented
RandomIterator	undocumented
RangeDownIterator	undocumented
RangeUpIterator	undocumented
ReducerFastIterator	undocumented
RepeatIterator	undocumented
StreamBase	A reusable base implementation for Stream that provides all high-level operations in terms of a FastIterator returned from [Symbol.iterator].
Custom stream implementations in @rimbu/stream/custom extend this class.
TakeIterator	undocumented
TransformerFastIterator	undocumented
UnfoldIterator	undocumented
ZipAllWithItererator	undocumented
ZipWithIterator	undocumented

Functions

isEmptyStreamSourceInstance

Returns true if the given source is a StreamSource that is known to be empty. If this function returns false, the source may still be empty; it is simply not known.

Definition

export declare function isEmptyStreamSourceInstance(source: StreamSource<any>): boolean;

Parameters

Name	Type	Description
source	StreamSource<any>	a potential stream source

isFastIterator

Returns true if the given iterator implements the FastIterator interface.

Definition

export declare function isFastIterator<T>(iterator: Iterator<T>): iterator is FastIterator<T>;

Type parameters

Name	Description
T

Parameters

Name	Type	Description
iterator	Iterator<T>	the iterator instance to test

Constants

Name	Description
emptyFastIterator	A FastIterator that is already exhausted and never yields values. Its fastNext method always returns the provided fallback value.
fixedDoneIteratorResult	A frozen IteratorResult instance representing the completed iterator state. This value is reused by several fast iterator implementations to avoid allocations.
fromStreamSource	Converts any StreamSource into a concrete Stream implementation.
StreamConstructorsImpl	Default implementation of the StreamConstructors interface. This instance backs the exported Stream value.