Struct Keyed

pub struct Keyed<S: Stream> { /* private fields */ }

Iterate over items in the stream group with their associated keys.

Methods from Deref<Target = StreamGroup<S>>

pub fn len(&self) -> usize

Return the number of futures currently active in the group.

Example

use futures_concurrency::stream::StreamGroup;
use futures_lite::stream;

let mut group = StreamGroup::with_capacity(2);
assert_eq!(group.len(), 0);
group.insert(stream::once(12));
assert_eq!(group.len(), 1);

pub fn capacity(&self) -> usize

Return the capacity of the StreamGroup.

Example

use futures_concurrency::stream::StreamGroup;
use futures_lite::stream;

let group = StreamGroup::with_capacity(2);
assert_eq!(group.capacity(), 2);

pub fn is_empty(&self) -> bool

Returns true if there are no futures currently active in the group.

Example

use futures_concurrency::stream::StreamGroup;
use futures_lite::stream;

let mut group = StreamGroup::with_capacity(2);
assert!(group.is_empty());
group.insert(stream::once(12));
assert!(!group.is_empty());

pub fn remove(&mut self, key: Key) -> bool

Removes a stream from the group. Returns whether the value was present in the group.

Example

use futures_lite::stream;
use futures_concurrency::stream::StreamGroup;

let mut group = StreamGroup::new();
let key = group.insert(stream::once(4));
assert_eq!(group.len(), 1);
group.remove(key);
assert_eq!(group.len(), 0);

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

Returns true if the StreamGroup contains a value for the specified key.

Example

use futures_lite::stream;
use futures_concurrency::stream::StreamGroup;

let mut group = StreamGroup::new();
let key = group.insert(stream::once(4));
assert!(group.contains_key(key));
group.remove(key);
assert!(!group.contains_key(key));

pub fn reserve(&mut self, additional: usize)

Reserves capacity for additional more streams to be inserted. Does nothing if the capacity is already sufficient.

Example

use futures_concurrency::stream::StreamGroup;
use futures_lite::stream::Once;
let mut group: StreamGroup<Once<usize>> = StreamGroup::with_capacity(0);
assert_eq!(group.capacity(), 0);
group.reserve(10);
assert_eq!(group.capacity(), 10);

// does nothing if capacity is sufficient
group.reserve(5);
assert_eq!(group.capacity(), 10);

pub fn insert(&mut self, stream: S) -> Key

where S: Stream,

Insert a new future into the group.

Example

use futures_concurrency::stream::StreamGroup;
use futures_lite::stream;

let mut group = StreamGroup::with_capacity(2);
group.insert(stream::once(12));

Trait Implementations

impl<S: Debug + Stream> Debug for Keyed<S>

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

Formats the value using the given formatter.

impl<S: Stream> Deref for Keyed<S>

type Target = StreamGroup<S>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S: Stream> DerefMut for Keyed<S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<S: Stream> Stream for Keyed<S>

type Item = (Key, <S 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.

impl<'pin, S: Stream> Unpin for Keyed<S>

where __Keyed<'pin, S>: Unpin,