Struct futures::stream::Fuse

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

A stream which "fuse"s a stream once it's terminated.

Normally streams can behave unpredictably when used after they have already finished, but Fuse continues to return None from poll forever when finished.

Methods

impl<St> Fuse<St> where     St: Stream,

pub fn is_done(&self) -> bool

Returns whether the underlying stream has finished or not.

If this method returns true, then all future calls to poll are guaranteed to return None. If this returns false, then the underlying stream is still in use.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, 

pub fn get_ref(&self) -> &St

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

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, 

pub fn get_mut(&mut self) -> &mut St

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 get_pin_mut(self: PinMut<'a, Fuse<St>>) -> PinMut<'a, St>

Acquires a mutable pinned 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

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<St> Debug for Fuse<St> where     St: Debug,

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<S> Sink for Fuse<S> where     S: Stream + Sink,

type SinkItem = <S as Sink>::SinkItem

The type of value that the sink accepts.

type SinkError = <S as Sink>::SinkError

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

fn poll_ready(     self: PinMut<Fuse<S>>,     cx: &mut Context ) -> Poll<Result<(), <Fuse<S> as Sink>::SinkError>>

Attempts to prepare the Sink to receive a value.

fn start_send(     self: PinMut<Fuse<S>>,     item: <Fuse<S> as Sink>::SinkItem ) -> Result<(), <Fuse<S> as Sink>::SinkError>

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

fn poll_flush(     self: PinMut<Fuse<S>>,     cx: &mut Context ) -> Poll<Result<(), <Fuse<S> as Sink>::SinkError>>

Flush any remaining output from this sink.

fn poll_close(     self: PinMut<Fuse<S>>,     cx: &mut Context ) -> Poll<Result<(), <Fuse<S> as Sink>::SinkError>>

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

impl<St> Unpin for Fuse<St> where     St: Unpin,

impl<S> Stream for Fuse<S> where     S: Stream,

type Item = <S as Stream>::Item

Values yielded by the stream.

fn poll_next(     self: PinMut<Fuse<S>>,     cx: &mut Context ) -> Poll<Option<<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.