Struct futures_util::stream::Scan[][src]

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

Stream for the scan method.

Implementations

impl<B, St, S, Fut, F> Scan<St, S, Fut, F> where
    St: Stream,
    F: FnMut(&mut S, St::Item) -> Fut,
    Fut: Future<Output = Option<B>>, 
[src]

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

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

pub fn get_mut(&mut self) -> &mut St[src]

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

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>

Notable traits for Pin<P>

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future
type Output = <<P as Deref>::Target as Future>::Output;
[src]

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

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

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

Consumes this combinator, returning the underlying sink or 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, S, Fut, F> Debug for Scan<St, S, Fut, F> where
    St: Stream + Debug,
    St::Item: Debug,
    S: Debug,
    Fut: Debug
[src]

impl<B, St, S, Fut, F> FusedStream for Scan<St, S, Fut, F> where
    St: FusedStream,
    F: FnMut(&mut S, St::Item) -> Fut,
    Fut: Future<Output = Option<B>>, 
[src]

impl<S, Fut, F, Item> Sink<Item> for Scan<S, S, Fut, F> where
    S: Stream + Sink<Item>, 
[src]

type Error = S::Error

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

impl<B, St, S, Fut, F> Stream for Scan<St, S, Fut, F> where
    St: Stream,
    F: FnMut(&mut S, St::Item) -> Fut,
    Fut: Future<Output = Option<B>>, 
[src]

type Item = B

Values yielded by the stream.

impl<'__pin, St: Stream, S, Fut, F> Unpin for Scan<St, S, Fut, F> where
    __Origin<'__pin, St, S, Fut, F>: Unpin
[src]

Auto Trait Implementations

impl<St, S, Fut, F> RefUnwindSafe for Scan<St, S, Fut, F> where
    F: RefUnwindSafe,
    Fut: RefUnwindSafe,
    S: RefUnwindSafe,
    St: RefUnwindSafe

impl<St, S, Fut, F> Send for Scan<St, S, Fut, F> where
    F: Send,
    Fut: Send,
    S: Send,
    St: Send

impl<St, S, Fut, F> Sync for Scan<St, S, Fut, F> where
    F: Sync,
    Fut: Sync,
    S: Sync,
    St: Sync

impl<St, S, Fut, F> UnwindSafe for Scan<St, S, Fut, F> where
    F: UnwindSafe,
    Fut: UnwindSafe,
    S: 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