[][src]Struct futures_util::stream::Filter

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

Stream for the filter method.

Methods

impl<St, Fut, F> Filter<St, Fut, F> where
    St: Stream,
    F: FnMut(&St::Item) -> Fut,
    Fut: Future<Output = bool>, 
[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, Fut, F> Unpin for Filter<St, Fut, F> where
    St: Stream + Unpin,
    Fut: Unpin
[src]

impl<St, Fut, F> Debug for Filter<St, Fut, F> where
    St: Stream + Debug,
    St::Item: Debug,
    Fut: Debug
[src]

impl<St, Fut, F> Stream for Filter<St, Fut, F> where
    St: Stream,
    F: FnMut(&St::Item) -> Fut,
    Fut: Future<Output = bool>, 
[src]

type Item = St::Item

Values yielded by the stream.

impl<St, Fut, F> FusedStream for Filter<St, Fut, F> where
    St: Stream + FusedStream,
    F: FnMut(&St::Item) -> Fut,
    Fut: Future<Output = bool>, 
[src]

impl<S, Fut, F, Item> Sink<Item> for Filter<S, Fut, F> where
    S: Stream + Sink<Item>,
    F: FnMut(&S::Item) -> Fut,
    Fut: Future<Output = bool>, 
[src]

type Error = S::Error

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

Auto Trait Implementations

impl<St, Fut, F> Send for Filter<St, Fut, F> where
    F: Send,
    Fut: Send,
    St: Send,
    <St as Stream>::Item: Send

impl<St, Fut, F> Sync for Filter<St, Fut, F> where
    F: Sync,
    Fut: Sync,
    St: Sync,
    <St as Stream>::Item: Sync

impl<St, Fut, F> UnwindSafe for Filter<St, Fut, F> where
    F: UnwindSafe,
    Fut: UnwindSafe,
    St: UnwindSafe,
    <St as Stream>::Item: UnwindSafe

impl<St, Fut, F> RefUnwindSafe for Filter<St, Fut, F> where
    F: RefUnwindSafe,
    Fut: RefUnwindSafe,
    St: RefUnwindSafe,
    <St as Stream>::Item: RefUnwindSafe

Blanket Implementations

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]

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

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

impl<T> From<T> for T[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<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

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

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