Struct tokio::sync::oneshot::Receiver

pub struct Receiver<T> { /* fields omitted */ }

This is supported on feature="sync" and feature="sync" only.

Receive a value from the associated Sender.

Instances are created by the channel function.

Methods

impl<T> Receiver<T>

pub fn close(&mut self)

This is supported on feature="sync" and feature="sync" only.

Prevent the associated Sender handle from sending a value.

Any send operation which happens after calling close is guaranteed to fail. After calling close, Receiver::poll] should be called to receive a value if one was sent before the call to close completed.

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

This is supported on feature="sync" and feature="sync" only.

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

Does not register a task if no value has been sent.

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

Returns an error if the sender was dropped.

Trait Implementations

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Debug> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> Future for Receiver<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>

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