Struct catty::Receiver

pub struct Receiver<T>(_);

The receiver side of a oneshot channel, created with catty::oneshot. This is a future resolving to item, or an error if the sender side has been dropped without sending a message. After a message is received, subsequent polls will return Err(Disconnected).

Example

let (tx, rx) = catty::oneshot();
tx.send("Hello!");
assert_eq!(rx.await, Ok("Hello!"));

Implementations

impl<T> Receiver<T>

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

Checks to see if there is a message waiting in the channel. This will return None if there a message has not been sent, and Err(Disconnected) if a message has already been received.

Examples

let (tx, mut rx) = catty::oneshot();
tx.send("Hello!");
assert_eq!(rx.try_recv(), Ok(Some("Hello!")));

Subsequent receives return Err(Disconnected):

let (tx, mut rx) = catty::oneshot();
tx.send("Hello!");
assert_eq!(rx.try_recv(), Ok(Some("Hello!")));
assert!(rx.try_recv().is_err());
assert_eq!(rx.await, Err(Disconnected))

Trait Implementations

impl<T> Future for Receiver<T>

type Output = Result<T, Disconnected>

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.