Struct CompleteHandle 

pub struct CompleteHandle<T> { /* private fields */ }

Available on crate feature sync only.

A thread-safe handle to complete the associated CompletableFuture. It can be safely dropped without setting a completion value.

fn func(complete_handle: CompleteHandle<u32>) {
    if let Some(res) = func_that_may_fail() {
        // Set the result.
        complete_handle.complete(res);
    }

    // Or just drop the handle.
}

If cloned, the handles race to complete the future.

async fn func(complete_handle: CompleteHandle<u32>) {
    let clone = complete_handle.clone();

    let a = async { complete_handle.complete(1); };
    let b = async { clone.complete(2); };

    futures::join!(a, b); // The handles race to set the result.
}

Implementations

impl<T> CompleteHandle<T>

pub fn complete(self, value: T) -> bool

Complete the future consuming the handle. Returns true if this handle has set the complete value.

Trait Implementations

impl<T> Clone for CompleteHandle<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Drop for CompleteHandle<T>

fn drop(&mut self)

Executes the destructor for this type.