[][src]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>[src]

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

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>[src]

type Output = Result<T, Disconnected>

The type of value produced on completion.

Auto Trait Implementations

impl<T> !RefUnwindSafe for Receiver<T>

impl<T> Send for Receiver<T> where
    T: Send

impl<T> Sync for Receiver<T> where
    T: Send

impl<T> Unpin for Receiver<T>

impl<T> !UnwindSafe for Receiver<T>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.