Struct Promise

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

A struct that accepts a value and notify the corresponding future.

Implementations

impl<T> Promise<T>

pub fn set_value(self, value: T) -> Option<T>

Offers a value to the promise.

It will wake up any awaited futures.

pub fn into_raw(s: Promise<T>) -> NonNull<MaybeUninit<T>>

Get a mutable pointer to the underlying value.

Remember to use from_raw to reclaim the memory and make notification work correctly.

pub unsafe fn from_raw(ptr: NonNull<MaybeUninit<T>>) -> Promise<T>

Reconstruct the promise from given pointer.

The pointer must be the returned value of into_raw.

Safety

If the pointer is not generated by into_raw, it can lead to undefined behavior.

pub unsafe fn assume_value_set(self)

Assumes the value is set.

It will wake up any awaited futures.

Safety

If no value has been set, calling the function lead to undefined behavior.

Trait Implementations

impl<T> Drop for Promise<T>

fn drop(&mut self)

Drops the promise.

It will wake up any awaited futures.

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