Trait async_std::stream::Extend

pub trait Extend<A> {
    pub fn extend<'a, T: IntoStream<Item = A> + 'a>(
        &'a mut self, 
        stream: T
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>>
    where
        <T as IntoStream>::IntoStream: Send;
}

This is supported on unstable only.

Extends a collection with the contents of a stream.

Streams produce a series of values asynchronously, and collections can also be thought of as a series of values. The Extend trait bridges this gap, allowing you to extend a collection asynchronously by including the contents of that stream. When extending a collection with an already existing key, that entry is updated or, in the case of collections that permit multiple entries with equal keys, that entry is inserted.

Examples

use async_std::prelude::*;
use async_std::stream;

let mut v: Vec<usize> = vec![1, 2];
let s = stream::repeat(3usize).take(3);
stream::Extend::extend(&mut v, s).await;

assert_eq!(v, vec![1, 2, 3, 3, 3]);

Required methods

pub fn extend<'a, T: IntoStream<Item = A> + 'a>(
    &'a mut self,
    stream: T
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <T as IntoStream>::IntoStream: Send, 

Extends a collection with the contents of a stream.

Loading content...

Implementations on Foreign Types

impl Extend<()> for ()

pub fn extend<'a, S: IntoStream<Item = ()> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<T: Send> Extend<T> for Vec<T>

pub fn extend<'a, S: IntoStream<Item = T> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl Extend<char> for String

pub fn extend<'a, S: IntoStream<Item = char> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<'b> Extend<&'b char> for String

pub fn extend<'a, S: IntoStream<Item = &'b char> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<'b> Extend<&'b str> for String

pub fn extend<'a, S: IntoStream<Item = &'b str> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl Extend<String> for String

pub fn extend<'a, S: IntoStream<Item = String> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<'b> Extend<Cow<'b, str>> for String

pub fn extend<'a, S: IntoStream<Item = Cow<'b, str>> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<T: Ord + Send> Extend<T> for BinaryHeap<T>

pub fn extend<'a, S: IntoStream<Item = T> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<K: Ord + Send, V: Send> Extend<(K, V)> for BTreeMap<K, V>

pub fn extend<'a, S: IntoStream<Item = (K, V)> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<T: Ord + Send> Extend<T> for BTreeSet<T>

pub fn extend<'a, S: IntoStream<Item = T> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<K, V, H> Extend<(K, V)> for HashMap<K, V, H> where
    K: Eq + Hash + Send,
    V: Send,
    H: BuildHasher + Default + Send, 

pub fn extend<'a, S: IntoStream<Item = (K, V)> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<T, H> Extend<T> for HashSet<T, H> where
    T: Eq + Hash + Send,
    H: BuildHasher + Default + Send, 

pub fn extend<'a, S: IntoStream<Item = T> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<T: Send> Extend<T> for LinkedList<T>

pub fn extend<'a, S: IntoStream<Item = T> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

impl<T: Send> Extend<T> for VecDeque<T>

pub fn extend<'a, S: IntoStream<Item = T> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

Loading content...

Implementors

impl<P: AsRef<Path>> Extend<P> for PathBuf

pub fn extend<'a, S: IntoStream<Item = P> + 'a>(
    &'a mut self,
    stream: S
) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> where
    <S as IntoStream>::IntoStream: Send, 

This is supported on unstable only.

Loading content...