Struct completable_future::CompletableFuture

pub struct CompletableFuture<V, E> { /* fields omitted */ }

A CompletableFuture is a future that you can expect a result (or error) from and chain logic on. You will need some executor to actively poll the result. Executors provided by the futures crate are usually good enough for common situations.

If you use a custom executor, be careful that don't poll the CompletableFuture after it has already completed (or errored) in previous polls. Doing so will panic your executor.

Methods

impl<V, E> CompletableFuture<V, E>

pub fn new() -> CompletableFuture<V, E>

Construct a CompletableFuture.

pub fn completed(val: V) -> CompletableFuture<V, E>

Construct a CompletableFuture that's already completed with the value provided.

pub fn errored(e: E) -> CompletableFuture<V, E>

Construct a CompletableFuture that's already errored with the value provided.

pub fn signal(&self) -> CompletableFutureSignal<V, E>

Get a CompletableFutureSignal that can be used to complete or error this CompletableFuture.

Trait Implementations

impl<V, E> Future for CompletableFuture<V, E>

type Item = V

A successful value

type Error = E

An error

fn poll(&mut self, ctx: &mut Context) -> Result<Async<Self::Item>, Self::Error>

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