Struct PartitionBy 

pub struct PartitionBy<St, Fut, F, K>
where
    St: Stream,
    K: Clone,
{ /* private fields */ }

A stream that partitions items from an underlying stream into multiple sub-streams based on keys generated by an async function.

This struct implements Stream and yields (K, Partitioned<St, K>) tuples, where each tuple represents a new partition with its associated key and the sub-stream for that partition.

Items from the underlying stream are processed through the key function f, and items with the same key are grouped together into the same partition stream.

Implementations

impl<St, Fut, F, K> PartitionBy<St, Fut, F, K>

where St: Stream, St::Item: Clone, F: Fn(&St::Item) -> Fut, Fut: Future<Output = K>, K: Hash + Eq + Clone,

Shared state between the main partitioning stream and all partition sub-streams.

This structure coordinates the distribution of items from the source stream to the appropriate partition streams. It maintains queues of pending items for each key and tracks the overall state of the partitioning operation.

pub fn get_partition(&mut self, key: K) -> Partitioned<St, Fut, F, K>

Gets a partition stream for a specific key.

Must not be called with the same key twice, otherwise items will be missed.

Arguments

• key - The key for which to get a partition stream

Returns

A Partitioned stream that yields only items matching the specified key.

pub fn register_keys<I>(&mut self, keys: I)

where I: IntoIterator<Item = K>,

Pre-creates queues for multiple keys.

Arguments

• keys - An iterator of keys to pre-register

pub fn allows_new_partitions(&self) -> bool

Returns whether new partitions are allowed to be created.

pub fn set_allow_new_queues(&mut self, allow: bool)

Sets whether new queues are allowed to be created.

If set to false, only keys that already have queues (either from previous calls to get_partition or register_keys) will receive items. Items for unknown keys will be dropped.

Trait Implementations

impl<'__pin, St, Fut, F, K> Unpin for PartitionBy<St, Fut, F, K>

where PinnedFieldsOf<__Origin<'__pin, St, Fut, F, K>>: Unpin, St: Stream, K: Clone,