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>

pub fn close(&mut self)

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>

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>

fn drop(&mut self)

Executes the destructor for this type.

impl<E> Stream for Receiver<E>

type Item = Result<NonZeroUsize, E>

Values yielded by the stream.

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

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.