Struct tiny_future::Future

pub struct Future<T, U = ()>(_);

A future result with an optional shared state

Implementations

impl<T, U> Future<T, U>

pub fn with_state(shared_state: U) -> Self

Creates a new Future<T, U> with shared_state as shared-state

pub fn set(&self, result: T) -> Result<(), State>

Sets the future

pub fn cancel(&self)

Cancels (poisons) the future

This is useful to indicate that the future is obsolete and should not be set anymore

pub fn get_state(&self) -> State

Returns the future's state

pub fn is_waiting(&self) -> bool

Checks if the future is still waiting or has been set/canceled

pub fn try_get(&self) -> Result<T, State>

Tries to get the future's result

If the future is ready, it is consumed and T is returned; if the future is not ready, Error::InvalidState(State) is returned

pub fn try_get_timeout(&self, timeout: Duration) -> Result<T, State>

Tries to get the future's result

If the future is ready or or becomes ready before the timeout occurres, it is consumed and T is returned; if the future is not ready, Error::InvalidState(State) is returned

pub fn get(&self) -> Result<T, State>

Gets the future's result

Warning: this function will block until a result becomes available

pub fn get_shared_state(&self) -> U where
    U: Clone, 

Get a clone of the current shared state

pub fn set_shared_state(&self, shared_state: U)

Replace the current shared state

pub fn access_shared_state<F: FnOnce(&mut U)>(&self, modifier: F)

Provides exclusive access to the shared state within modifier until modifier returns

pub fn access_shared_state_param<V, F: FnOnce(&mut U, V)>(
    &self,
    modifier: F,
    parameter: V
)

Provides exclusive access to the shared state within modifier until modifier returns

pub fn detach(&self)

Detaches the future so it won't be canceled if there is only one instance left

Useful if you either don't want that your future is ever canceled or if there's always only one instance (e.g. if you wrap it into a reference-counting container)

impl<T> Future<T, ()>

pub fn new() -> Self

Trait Implementations

impl<T, U> Clone for Future<T, U>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Default for Future<T, U> where
    U: Default, 

pub fn default() -> Self

Returns the "default value" for a type.

impl<T, U> Drop for Future<T, U>

pub fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send, U: Send> Send for Future<T, U>

impl<T, U> Sync for Future<T, U>