[][src]Struct futures_util::stream::Map

#[must_use = "streams do nothing unless polled"]
pub struct Map<St, F> { /* fields omitted */ }

Stream for the map method.

Methods

impl<St, T, F> Map<St, F> where
    St: Stream,
    F: FnMut(St::Item) -> T, 
[src]

Important traits for &'_ mut F
pub fn get_ref(&self) -> &St[src]

Acquires a reference to the underlying stream that this combinator is pulling from.

Important traits for &'_ mut F
pub fn get_mut(&mut self) -> &mut St[src]

Acquires a mutable reference to the underlying stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

Important traits for Pin<P>
pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>[src]

Acquires a pinned mutable reference to the underlying stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

pub fn into_inner(self) -> St[src]

Consumes this combinator, returning the underlying stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<St, F> Debug for Map<St, F> where
    St: Debug
[src]

impl<St, F, T> FusedStream for Map<St, F> where
    St: FusedStream,
    F: FnMut(St::Item) -> T, 
[src]

impl<S, F, T, Item> Sink<Item> for Map<S, F> where
    S: Stream + Sink<Item>,
    F: FnMut(S::Item) -> T, 
[src]

type Error = S::Error

The type of value produced by the sink when an error occurs.

impl<St, F, T> Stream for Map<St, F> where
    St: Stream,
    F: FnMut(St::Item) -> T, 
[src]

type Item = T

Values yielded by the stream.

impl<St: Unpin, F> Unpin for Map<St, F>[src]

Auto Trait Implementations

impl<St, F> RefUnwindSafe for Map<St, F> where
    F: RefUnwindSafe,
    St: RefUnwindSafe

impl<St, F> Send for Map<St, F> where
    F: Send,
    St: Send

impl<St, F> Sync for Map<St, F> where
    F: Sync,
    St: Sync

impl<St, F> UnwindSafe for Map<St, F> where
    F: UnwindSafe,
    St: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future