Enum EffectOutcome 

#[non_exhaustive]
pub enum EffectOutcome<T> {
    Committed(T),
    Failed(ErrorRecord),
    Rejected(ErrorRecord),
    Unknown {
        id: EffectId,
    },
    NeedsIntervention {
        id: EffectId,
    },
    InProgress {
        id: EffectId,
    },
    AwaitingApproval {
        id: EffectId,
    },
    Compensated {
        id: EffectId,
    },
}

How an effect ended, or where it stands.

Unknown and NeedsIntervention are results, not errors: the effect may have changed the outside world, and the caller must not treat it as failed.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Committed(T)

The effect applied. Carries the action’s output, from this call or from the record of an earlier one.

Failed(ErrorRecord)

The effect definitely did not apply and will not be retried.

Rejected(ErrorRecord)

The effect was refused before it ran.

Unknown

The effect may or may not have applied. Calling again with the same key resolves it if that is safe.

Fields

id: EffectId

The effect.

NeedsIntervention

The runtime cannot resolve the outcome safely; an operator must.

Fields

id: EffectId

The effect.

InProgress

Another caller or worker is running the effect right now.

Fields

id: EffectId

The effect.

AwaitingApproval

The effect waits for a human decision. Call again later, or have an operator use Runtime::approve / Runtime::deny.

Fields

id: EffectId

The effect.

Compensated

The effect applied and was later undone by compensation.

Fields

id: EffectId

The effect.

Trait Implementations

impl<T: Clone> Clone for EffectOutcome<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for EffectOutcome<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for EffectOutcome<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for EffectOutcome<T>