Struct ReceiverRef

pub struct ReceiverRef<'a, T> { /* private fields */ }

A borrowing handle for receiving elements through a split OneshotChannel.

Note

This receiver implements [Future] and can be awaited directly:

let mut chan = async_unsync::oneshot::channel();
let (tx, rx) = chan.split();
tx.send(()).unwrap();
let _ = rx.await;

Implementations

impl<T> ReceiverRef<'_, T>

pub fn is_closed(&self) -> bool

Returns true if the channel has been closed.

pub fn close(&mut self)

Closes the channel, causing any closed or subsequent poll_closed calls to resolve and any subsequent sends to fail on the corresponding SenderRef.

pub fn try_recv(&mut self) -> Result<T, TryRecvError>

Receives an element through the channel.

Errors

Fails, if the channel is empty or disconnected.

Trait Implementations

impl<T> Debug for ReceiverRef<'_, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Drop for ReceiverRef<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Future for ReceiverRef<'_, T>

type Output = Result<T, RecvError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.