Struct StreamMap 

pub struct StreamMap<K, S> { /* private fields */ }

Combining multiple streams into one, with each stream having a unique key.

Implementations

impl<K, T> StreamMap<K, T>

where K: Clone + Unpin, T: Stream + Send + Unpin + 'static,

pub fn new() -> Self

Creates an empty StreamMap

impl<K, T> StreamMap<K, T>

where K: Clone + PartialEq + Send + Unpin + 'static, T: Stream + Send + Unpin + 'static,

pub fn insert(&mut self, key: K, stream: T) -> bool

Insert a stream into the map with a unique key. The function will return true if the map does not have the key present, otherwise it will return false

pub fn set_wake_on_success(&mut self, key: &K, wake_on_success: bool) -> bool

Mark stream with assigned key to wake up on successful yield. Will return false if stream does not exist or if value is the same as previously set.

pub fn iter(&self) -> impl Iterator<Item = (&K, &T)>

An iterator visiting all key-value pairs in arbitrary order.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&K, &mut T)>

An iterator visiting all key-value pairs mutably in arbitrary order.

pub fn iter_pin(&mut self) -> impl Iterator<Item = (&K, Pin<&mut T>)>

An iterator visiting all key-value pairs with a pinned valued in arbitrary order

pub fn keys(&self) -> impl Iterator<Item = &K>

Returns an iterator visiting all keys in arbitrary order.

pub fn values(&self) -> impl Iterator<Item = &T>

An iterator visiting all values in arbitrary order.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut T>

An iterator visiting all values mutably in arbitrary order.

pub fn contains_key(&self, key: &K) -> bool

Returns true if the map contains a stream for the specified key.

pub fn clear(&mut self)

Clears the map.

pub fn get(&self, key: &K) -> Option<&T>

Returns a reference to the stream corresponding to the key.

pub fn get_mut(&mut self, key: &K) -> Option<&mut T>

Returns a mutable stream to the value corresponding to the key.

pub fn get_mut_or_default(&mut self, key: &K) -> &mut T

where T: Default,

Returns a muable stream or default value if it does not exist.

pub fn get_pinned(&mut self, key: &K) -> Option<Pin<&mut T>>

Returns a pinned stream corresponding to the key.

pub fn remove(&mut self, key: &K) -> Option<T>

Removes a key from the map, returning the stream.

pub fn len(&self) -> usize

Returns the number of streams in the map.

pub fn is_empty(&self) -> bool

Return true map contains no elements.

Trait Implementations

impl<K, T> Default for StreamMap<K, T>

where K: Clone + Unpin, T: Stream + Send + Unpin + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<K, T> FromIterator<(K, T)> for StreamMap<K, T>

where K: Clone + PartialEq + Send + Unpin + 'static, T: Stream + Send + Unpin + 'static,

fn from_iter<I: IntoIterator<Item = (K, T)>>(iter: I) -> Self

Creates a value from an iterator.

impl<K, T> FusedStream for StreamMap<K, T>

where K: Clone + PartialEq + Send + Unpin + 'static, T: Stream + Unpin + Send + 'static,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<K, T> Stream for StreamMap<K, T>

where K: Clone + PartialEq + Send + Unpin + 'static, T: Stream + Unpin + Send + 'static,

type Item = (K, <T as Stream>::Item)

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.