[][src]Struct futures::stream::Filter

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

A stream combinator used to filter the results of a stream and only yield some values.

This structure is produced by the Stream::filter method.

Methods

impl<S, F> Filter<S, F>[src]

pub fn get_ref(&self) -> &S[src]

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

pub fn get_mut(&mut self) -> &mut S[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.

pub fn into_inner(self) -> S[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<S, F> Stream for Filter<S, F> where
    S: Stream,
    F: FnMut(&S::Item) -> bool
[src]

type Item = S::Item

The type of item this stream will yield on success.

type Error = S::Error

The type of error this stream may generate.

impl<S, F> Sink for Filter<S, F> where
    S: Sink
[src]

type SinkItem = S::SinkItem

The type of value that the sink accepts.

type SinkError = S::SinkError

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

impl<S: Debug, F: Debug> Debug for Filter<S, F>[src]

Auto Trait Implementations

impl<S, F> Unpin for Filter<S, F> where
    F: Unpin,
    S: Unpin

impl<S, F> Send for Filter<S, F> where
    F: Send,
    S: Send

impl<S, F> Sync for Filter<S, F> where
    F: Sync,
    S: Sync

impl<S, F> UnwindSafe for Filter<S, F> where
    F: UnwindSafe,
    S: UnwindSafe

impl<S, F> RefUnwindSafe for Filter<S, F> where
    F: RefUnwindSafe,
    S: RefUnwindSafe

Blanket Implementations

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> Into<U> for T where
    U: From<T>, 
[src]

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

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

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