Struct StreamPool 

pub struct StreamPool<F: StreamFactory> { /* private fields */ }

Represents a pool of streams, managing a collection of streams created by a factory.

Implementations

impl<F: StreamFactory> StreamPool<F>

pub fn new(backend: F, max_streams: u8, num_special: u8) -> Self

Creates a new stream pool with the given backend factory and capacity constraints.

pub fn streams(&self) -> impl Iterator<Item = &F::Stream>

Read-only iterator over initialized streams (unlike Self::get_mut, never creates one).

pub fn stream_ids(&self) -> impl Iterator<Item = StreamId> + '_

Synthetic StreamIds, one per initialized regular pool slot.

Each id round-trips through Self::get_mut to the same slot it came from (slot i is reachable via StreamId { value: i } since indexing is value % max_streams), so it’s safe to feed these ids back into per-stream APIs.

pub fn get_mut(&mut self, stream_id: &StreamId) -> &mut F::Stream

Retrieves a mutable reference to a stream for a given stream ID.

pub unsafe fn get_mut_index(&mut self, index: usize) -> &mut F::Stream

Retrieves a mutable reference to a stream at the specified index, initializing it if needed.

Safety

• Caller must ensure the index is valid (less than max_streams + num_special).
• Lifetimes still follow the Rust rules.

pub unsafe fn get_special(&mut self, index: u8) -> &mut F::Stream

Retrieves a mutable reference to a special stream at the given index.

Safety

• Caller must ensure the index corresponds to a valid special stream.
• Lifetimes still follow the Rust rules.

pub fn stream_index(&mut self, id: &StreamId) -> usize

Calculates the index for a given stream ID, mapping it to the pool’s capacity.

pub fn factory_mut(&mut self) -> &mut F

Mutable access to the factory, e.g. to change the configuration new streams are created with. Already-created streams are unaffected.

Trait Implementations

impl<F: Debug + StreamFactory> Debug for StreamPool<F>

where F::Stream: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.