Struct Deferred 

pub struct Deferred<A, E> { /* private fields */ }

Shared one-shot cell completed with an Exit value.

Implementations

impl<A, E> Deferred<A, E>

where A: Clone + Send + Sync + 'static, E: Clone + Send + Sync + 'static,

pub fn make() -> Effect<Deferred<A, E>, Never, ()>

Create an incomplete deferred (watch value starts at None).

pub fn wait(&self) -> Effect<A, Cause<E>, ()>

Suspend until a completion is stored, then return success or the failure Cause.

The error channel is Cause<E> so interrupt / die / structured failures surface faithfully.

pub fn wait_future( &self, ) -> impl Future<Output = Result<A, Cause<E>>> + Send + 'static

where A: Clone + Send + Sync + 'static, E: Clone + Send + Sync + 'static,

Like Self::wait, but returns a Send future for use inside tokio::spawn and other multi-thread executors (the boxed Effect future from Effect::run is not Send).

pub fn try_succeed(&self, value: A) -> bool

where A: Clone,

Try to complete with success (non-blocking). Returns whether this was the first completion.

pub fn try_fail_cause(&self, cause: Cause<E>) -> bool

where E: Clone,

Try to complete with a failure Cause (non-blocking).

pub fn poll(&self) -> Effect<Option<Exit<A, E>>, Never, ()>

Non-blocking read of the current exit, if any.

pub fn is_done(&self) -> Effect<bool, Never, ()>

Returns whether this deferred has been completed (watch value is Some).

pub fn succeed(&self, value: A) -> Effect<bool, Never, ()>

Complete with success. Returns true if this was the first completion.

pub fn fail(&self, error: E) -> Effect<bool, Never, ()>

Complete with Exit::fail. Returns true if this was the first completion.

pub fn fail_cause(&self, cause: Cause<E>) -> Effect<bool, Never, ()>

Complete with an arbitrary Cause. Returns true if this was the first completion.

pub fn interrupt(&self) -> Effect<bool, Never, ()>

Complete with Exit::interrupt. Returns true if this was the first completion.

pub fn complete<R>(&self, eff: Effect<A, E, R>) -> Effect<bool, E, R>

Run eff; on success, complete with Exit::succeed. Returns whether this was the first completion. Effect errors from eff are returned as Err without completing the deferred.

pub fn unsafe_done(&self, exit: Exit<A, E>) -> Effect<(), Never, ()>

Force the stored exit, overwriting any prior value (use sparingly).

Trait Implementations

impl<A: Clone, E: Clone> Clone for Deferred<A, E>

fn clone(&self) -> Deferred<A, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug, E: Debug> Debug for Deferred<A, E>

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

Formats the value using the given formatter.