Promise

Struct Promise 

Source
pub struct Promise<T>(/* private fields */);
Expand description

A box for resolving a Future.

A Promise is a write-once box which corresponds with a Future and may be used to resolve it.

A Promise is initially pending, and is completed once it is consumed, either by its set method, or by going out of scope. The former is “fulfilling” the Promise; the latter is leaving it “unfulfilled”.

It may only be created in a pair with a Future using the function future_promise().

Implementations§

Source§

impl<T> Promise<T>

Source

pub fn set(self, v: T)

Fulfill the Promise by resolving the corresponding Future with a value.

Source

pub fn canceled(&self) -> bool

Return true if the corresponding Future no longer exists, and so any value set would be discarded.

let (fut, prom) = future_promise();

thread::spawn(move || {
    let mut s = State::new();
    while !prom.canceled() {
        match s.perform_action() {
            None => (),
            Some(res) => { prom.set(res); break },
        }
    }
});
// ...
mem::drop(fut);

Trait Implementations§

Source§

impl<T: Debug> Debug for Promise<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Promise<T>

§

impl<T> RefUnwindSafe for Promise<T>

§

impl<T> Send for Promise<T>
where T: Send,

§

impl<T> Sync for Promise<T>
where T: Send,

§

impl<T> Unpin for Promise<T>

§

impl<T> UnwindSafe for Promise<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.