Struct Fuse

pub struct Fuse<S> { /* private fields */ }

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.

Implementations

impl<S> Fuse<S>

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.

pub fn get_ref(&self) -> &S

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

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

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 into_inner(self) -> S

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<S> Debug for Fuse<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> Sink for Fuse<S>

where S: 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( &mut self, cx: &mut Context<'_>, ) -> Result<Async<()>, <Fuse<S> as Sink>::SinkError>

Attempts to prepare the Sink to receive a value.

fn start_send( &mut self, 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 preceded by a successful call to poll_ready which returned Ok(Async::Ready(())).

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

Flush any remaining output from this sink.

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

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

impl<S> Stream for Fuse<S>

where S: Stream,

type Item = <S as Stream>::Item

Values yielded by the stream.

type Error = <S as Stream>::Error

Errors yielded by the stream.

fn poll_next( &mut self, cx: &mut Context<'_>, ) -> Result<Async<Option<<S as Stream>::Item>>, <S as Stream>::Error>

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.