Struct futures_channel::oneshot::Receiver

[+] Show declaration

[+] Expand attributes
#[must_use = "futures do nothing unless polled"]
pub struct Receiver<T> { /* fields omitted */ }

[−] Expand description

A future for a value that will be provided by another asynchronous task.

This is created by the channel function.

Methods

impl<T> Receiver<T>[−]

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<T>, Canceled>[+]

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

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

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> Unpin for Receiver<T>

impl<T> Drop for Receiver<T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[+]

Executes the destructor for this type.

impl<T: Debug> Debug for Receiver<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T> Future for Receiver<T>[+]

[+] Show hidden undocumented items

type Output = Result<T, Canceled>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<T, Canceled>>[+]

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