[][src]Struct futures::stream::Peekable

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

A Stream that implements a peek method.

The peek method can be used to retrieve a reference to the next Stream::Item if available. A subsequent call to poll will return the owned item.

Methods

impl<St> Peekable<St> where
    St: Stream
[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 Peekable<St>>) -> 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.

pub fn poll_peek(
    self: Pin<&mut Peekable<St>>,
    cx: &mut Context
) -> Poll<Option<&<St as Stream>::Item>>
[src]

Peek retrieves a reference to the next item in the stream.

This method polls the underlying stream and return either a reference to the next item if the stream is ready or passes through any errors.

Trait Implementations

impl<St> Unpin for Peekable<St> where
    St: Unpin + Stream
[src]

impl<S, Item> Sink<Item> for Peekable<S> where
    S: Sink<Item> + Stream
[src]

type Error = <S as Sink<Item>>::Error

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

impl<St> Debug for Peekable<St> where
    St: Debug + Stream,
    <St as Stream>::Item: Debug
[src]

impl<S> Stream for Peekable<S> where
    S: Stream
[src]

type Item = <S as Stream>::Item

Values yielded by the stream.

impl<St> FusedStream for Peekable<St> where
    St: Stream
[src]

Auto Trait Implementations

impl<St> Send for Peekable<St> where
    St: Send,
    <St as Stream>::Item: Send

impl<St> Sync for Peekable<St> where
    St: Sync,
    <St as Stream>::Item: Sync

impl<St> UnwindSafe for Peekable<St> where
    St: UnwindSafe,
    <St as Stream>::Item: UnwindSafe

impl<St> RefUnwindSafe for Peekable<St> where
    St: RefUnwindSafe,
    <St as Stream>::Item: RefUnwindSafe

Blanket Implementations

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

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

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

type Error = !

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> 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]

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

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]