Struct gaffer::future::Promise

pub struct Promise<T> { /* fields omitted */ }

The sending side of a promise which can be used to complete a future. If 2 promises are of the same type, they can be merged and then all the futures will be resolved with clones of the result.

Implementations

impl<T> Promise<T>

pub fn new() -> (Promise<T>, PromiseFuture<T>)

Create the sending and receiving parts of the promise.

pub fn fulfill_unmergable(self, result: T)

Fulfill the promise, the future will be woken and can retrieve the result, if used on a merged Promise the merged futures will receive PromiseDropped. So prefer Promise::fulfill on mergable results.

impl<T: Clone> Promise<T>

pub fn fulfill(self, result: T)

Fulfill the promise, the future will be woken and can retrieve the result. Any merged Promises will be fulfilled at the same time

pub fn merge(&mut self, other: Self)

Merge another promise of the same type into this promise, the future paired with the other promise will be linked to this and will be completed when this one is fulfilled or dropped.

Trait Implementations

impl<T> Drop for Promise<T>

fn drop(&mut self)

Executes the destructor for this type.