[][src]Struct futures::sync::oneshot::Receiver

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

A future representing the completion of a computation happening elsewhere in memory.

This is created by the oneshot::channel function.

Methods

impl<T> Receiver<T>[src]

pub fn close(&mut self)[src]

Gracefully close this receiver, preventing sending any future messages.

Any send operation which happens after this method returns is guaranteed to fail. Once this method is called the normal poll method can be used to determine whether a message was actually sent or not. If Canceled is returned from poll then no message was sent.

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

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

Useful when a Context is not available such as within a Drop impl.

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> Future for Receiver<T>[src]

type Item = T

The type of value that this future will resolved with if it is successful. Read more

type Error = Canceled

The type of error that this future will resolve with if it fails in a normal fashion. Read more

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

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

Auto Trait Implementations

impl<T> Unpin for Receiver<T>

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

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

impl<T> !UnwindSafe for Receiver<T>

impl<T> !RefUnwindSafe for Receiver<T>

Blanket Implementations

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

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

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

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> Into<U> for T where
    U: From<T>, 
[src]

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.

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

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

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