Struct futures_channel::mpsc::UnboundedReceiver[][src]

pub struct UnboundedReceiver<T>(_);

The receiving end of an unbounded mpsc channel.

This value is created by the unbounded function.

Implementations

impl<T> UnboundedReceiver<T>[src]

pub fn close(&mut self)[src]

Closes the receiving half of the channel, without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

pub fn try_next(&mut self) -> Result<Option<T>, TryRecvError>[src]

Tries to receive the next message without notifying a context if empty.

It is not recommended to call this function from inside of a future, only when you’ve otherwise arranged to be notified when the channel is no longer empty.

This function will panic if called after try_next or poll_next has returned None.

Trait Implementations

impl<T: Debug> Debug for UnboundedReceiver<T>[src]

impl<T> FusedStream for UnboundedReceiver<T>[src]

impl<T> Stream for UnboundedReceiver<T>[src]

type Item = T

Values yielded by the stream.

impl<T> Unpin for UnboundedReceiver<T>[src]

Auto Trait Implementations

impl<T> !RefUnwindSafe for UnboundedReceiver<T>

impl<T> Send for UnboundedReceiver<T> where
    T: Send

impl<T> Sync for UnboundedReceiver<T> where
    T: Send

impl<T> !UnwindSafe for UnboundedReceiver<T>

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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 = Infallible

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