Struct futures::prelude::stream::Peekable

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

[−] Expand description

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.

Implementations

impl<St> Peekable<St> where
    St: Stream, [−]

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

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

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

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 Peekable<St>>) -> Pin<&mut St>[−]

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

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.

pub fn peek(self: Pin<&mut Peekable<St>>) -> Peek<'_, St>[−]

Produces a Peek future which retrieves a reference to the next item in the stream, or None if the underlying stream terminates.

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

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.

pub fn next_if<F>(self: Pin<&mut Peekable<St>>, func: F) -> NextIf<'_, St, F> where
    F: FnOnce(&<St as Stream>::Item) -> bool, [−]

Creates a future which will consume and return the next value of this stream if a condition is true.

If func returns true for the next value of this stream, consume and return it. Otherwise, return None.

Examples

Consume a number if it’s equal to 0.

use futures::stream::{self, StreamExt};
use futures::pin_mut;

let stream = stream::iter(0..5).peekable();
pin_mut!(stream);
// The first item of the stream is 0; consume it.
assert_eq!(stream.as_mut().next_if(|&x| x == 0).await, Some(0));
// The next item returned is now 1, so `consume` will return `false`.
assert_eq!(stream.as_mut().next_if(|&x| x == 0).await, None);
// `next_if` saves the value of the next item if it was not equal to `expected`.
assert_eq!(stream.next().await, Some(1));

Consume any number less than 10.

use futures::stream::{self, StreamExt};
use futures::pin_mut;

let stream = stream::iter(1..20).peekable();
pin_mut!(stream);
// Consume all numbers less than 10
while stream.as_mut().next_if(|&x| x < 10).await.is_some() {}
// The next value returned will be 10
assert_eq!(stream.next().await, Some(10));

pub fn next_if_eq<T>(
    self: Pin<&'a mut Peekable<St>>,
    expected: &'a T
) -> NextIfEq<'a, St, T> where
    T: ?Sized,
    <St as Stream>::Item: PartialEq<T>, [−]

Creates a future which will consume and return the next item if it is equal to expected.

Example

Consume a number if it’s equal to 0.

use futures::stream::{self, StreamExt};
use futures::pin_mut;

let stream = stream::iter(0..5).peekable();
pin_mut!(stream);
// The first item of the stream is 0; consume it.
assert_eq!(stream.as_mut().next_if_eq(&0).await, Some(0));
// The next item returned is now 1, so `consume` will return `false`.
assert_eq!(stream.as_mut().next_if_eq(&0).await, None);
// `next_if_eq` saves the value of the next item if it was not equal to `expected`.
assert_eq!(stream.next().await, Some(1));

Trait Implementations

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

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

pub fn is_terminated(&self) -> bool[−]

Returns true if the stream should no longer be polled.

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

[+] Show hidden undocumented items

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

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

pub fn poll_ready(
    self: Pin<&mut Peekable<S>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <Peekable<S> as Sink<Item>>::Error>>[−]

Attempts to prepare the Sink to receive a value.

pub fn start_send(
    self: Pin<&mut Peekable<S>>,
    item: Item
) -> Result<(), <Peekable<S> as Sink<Item>>::Error>[−]

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

pub fn poll_flush(
    self: Pin<&mut Peekable<S>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <Peekable<S> as Sink<Item>>::Error>>[−]

Flush any remaining output from this sink.

pub fn poll_close(
    self: Pin<&mut Peekable<S>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <Peekable<S> as Sink<Item>>::Error>>[−]

Flush any remaining output and close this sink, if necessary.

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

[+] Show hidden undocumented items

type Item = <S as Stream>::Item

Values yielded by the stream.

pub fn poll_next(
    self: Pin<&mut Peekable<S>>,
    cx: &mut Context<'_>
) -> Poll<Option<<Peekable<S> as Stream>::Item>>[−]

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)[−]

Returns the bounds on the remaining length of the stream.

impl<'__pin, St> Unpin for Peekable<St> where
    St: Stream,
    __Origin<'__pin, St>: Unpin,