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

#[must_use = "streams do nothing unless polled"]
pub struct Peekable<S: 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.


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

pub fn peek(&mut self) -> Poll<Option<&S::Item>, S::Error>[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<S: Stream> Stream for Peekable<S>[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> Sink for Peekable<S> where
    S: Sink + Stream

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 + Stream> Debug for Peekable<S> where
    S::Item: Debug

Auto Trait Implementations

impl<S> Unpin for Peekable<S> where
    S: Unpin,
    <S as Stream>::Item: Unpin

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

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

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

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

Blanket Implementations

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

impl<T> BorrowMut<T> for T where
    T: ?Sized

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