Skip to main content

RecoveryAction

Enum RecoveryAction 

Source
#[non_exhaustive]
pub enum RecoveryAction { Nothing { phase: TurnPhase, }, RestartInterpretation, ResumeCommands { entries: Vec<CommandJournalEntry>, }, RegenerateResponse { events: Vec<StoredEvent>, answer_tasks: Vec<AnswerTask>, }, ReconcileExternal { attempts: Vec<AttemptId>, entries: Vec<CommandJournalEntry>, }, }
Expand description

What recovery decided to do with a turn (spec §23.1).

“Unfinished” is not quite the right word for what this covers, and the difference matters: a turn can be TurnPhase::Delivered — the user has a truthful answer, saying the request is being verified — while an external effect it started is still unsettled. Recovery therefore looks at the journal before it looks at the phase.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Nothing

The turn is finished; there is nothing to do.

Fields

§phase: TurnPhase

The phase it finished in.

§

RestartInterpretation

No command was ever admitted, so nothing can have happened and the turn may be interpreted again from the start.

§

ResumeCommands

Commands were admitted and not settled. They are resumed by idempotency key: handing the executor these entries lets it recognise what already ran instead of running it twice (I14).

Fields

§entries: Vec<CommandJournalEntry>

The entries to resume, in admission order.

§

RegenerateResponse

Everything that was going to commit has committed. The response is rebuilt from the ledger and the stored plan, and nothing is executed.

Fields

§events: Vec<StoredEvent>

The events the turn committed, in append order.

§answer_tasks: Vec<AnswerTask>

The questions the turn planned, as answer tasks.

§

ReconcileExternal

An external effect may or may not have happened. It is settled against the remote system by attempt identifier, never repeated blindly (I15).

Fields

§attempts: Vec<AttemptId>

The attempts to settle, in the order they were made.

§entries: Vec<CommandJournalEntry>

The journal entries that carry them.

Implementations§

Source§

impl RecoveryAction

Source

pub const fn may_cause_effects(&self) -> bool

Returns true when acting on this decision may cause a domain effect.

Only Self::ResumeCommands can, and even then only through the idempotency key.

Source

pub const fn as_str(&self) -> &'static str

Stable snake-case label, for metrics and logs.

Trait Implementations§

Source§

impl Clone for RecoveryAction

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecoveryAction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RecoveryAction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RecoveryAction

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more