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>

fn close(&mut self)

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.

Trait Implementations

impl<T> Future for Receiver<T>

type Item = T

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

type Error = Canceled

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

fn poll(&mut self) -> Poll<T, Canceled>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error> where Self: Sized

Block the current thread until this future is resolved.

fn boxed(self) -> BoxFuture<Self::Item, Self::Error> where Self: Sized + Send + 'static

Convenience function for turning this future into a trait object.

fn map<F, U>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Item) -> U, Self: Sized

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> E, Self: Sized

Map this future's error to a different error, returning a new future.

fn from_err<F, E: From<Self::Error>>(self) -> FromErr<Self, E> where Self: Sized

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where F: FnOnce(Result<Self::Item, Self::Error>) -> B, B: IntoFuture, Self: Sized

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where F: FnOnce(Self::Item) -> B, B: IntoFuture<Error=Self::Error>, Self: Sized

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where F: FnOnce(Self::Error) -> B, B: IntoFuture<Item=Self::Item>, Self: Sized

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, B::Future> where B: IntoFuture<Item=Self::Item, Error=Self::Error>, Self: Sized

Waits for either one of two futures to complete.

fn join<B>(self, other: B) -> Join<Self, B::Future> where B: IntoFuture<Error=Self::Error>, Self: Sized

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(self, b: B, c: C) -> Join3<Self, B::Future, C::Future> where B: IntoFuture<Error=Self::Error>, C: IntoFuture<Error=Self::Error>, Self: Sized

Same as join, but with more futures.

fn join4<B, C, D>(self,
                  b: B,
                  c: C,
                  d: D)
                  -> Join4<Self, B::Future, C::Future, D::Future> where B: IntoFuture<Error=Self::Error>, C: IntoFuture<Error=Self::Error>, D: IntoFuture<Error=Self::Error>, Self: Sized

Same as join, but with more futures.

fn join5<B, C, D, E>(self,
                     b: B,
                     c: C,
                     d: D,
                     e: E)
                     -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where B: IntoFuture<Error=Self::Error>, C: IntoFuture<Error=Self::Error>, D: IntoFuture<Error=Self::Error>, E: IntoFuture<Error=Self::Error>, Self: Sized

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self> where Self: Sized

Convert this future into single element stream.

fn flatten(self) -> Flatten<Self> where Self::Item: IntoFuture, Self::Item::Error: From<Self::Error>, Self: Sized

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where Self::Item: Stream<Error=Self::Error>, Self: Sized

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self> where Self: Sized

Fuse a future such that poll will never again be called once it has completed.

fn catch_unwind(self) -> CatchUnwind<Self> where Self: Sized + UnwindSafe

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self> where Self: Sized

Convert this future into Shared future.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

A method called when the value goes out of scope.