[][src]Struct drone_core::sync::spsc::pulse::Receiver

#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Receiver<E> { /* fields omitted */ }

The receiving-half of pulse::channel.

Methods

impl<E> Receiver<E>[src]

pub fn close(&mut self)[src]

Gracefully close this receiver, preventing any subsequent attempts to send to it.

Any send operation which happens after this method returns is guaranteed to fail. After calling this method, you can use Receiver::poll to determine whether a message had previously been sent.

pub fn try_recv(&mut self) -> Result<Option<NonZeroUsize>, E>[src]

Attempts to receive pulses outside of the context of a task.

Does not schedule a task wakeup or have any other side effects.

A return value of Ok(None) must be considered immediately stale (out of date) unless close has been called first.

Trait Implementations

impl<E> Drop for Receiver<E>[src]

impl<E> Stream for Receiver<E>[src]

type Item = Result<NonZeroUsize, E>

Values yielded by the stream.

Auto Trait Implementations

impl<E> Unpin for Receiver<E>

impl<E> Send for Receiver<E> where
    E: Send

impl<E> Sync for Receiver<E> where
    E: Send

Blanket Implementations

impl<T> From<T> for 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> Into<U> for T where
    U: From<T>, 
[src]

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<T> Borrow<T> for T where
    T: ?Sized
[src]

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

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

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

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]