Struct TripWorkflow 

#[non_exhaustive]
pub struct TripWorkflow { /* private fields */ }

The trip workflow: the disruption case of one booking.

Implementations

impl TripWorkflow

pub const fn new() -> Self

Builds the workflow: a rebooking is the only step a card confirms.

pub const fn with_cards(self) -> Self

The same workflow with a click for withdrawing and a review card for changing the traveler, for exercising the card machinery; the sample itself asks for neither.

pub fn phase_of(state: &TripState) -> TripPhase

The phase a stored status projects to.

Trait Implementations

impl Clone for TripWorkflow

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TripWorkflow

impl Debug for TripWorkflow

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

Formats the value using the given formatter.

impl Default for TripWorkflow

fn default() -> Self

Returns the “default value” for a type.

impl PureWorkflow for TripWorkflow

fn apply( &self, state: Option<&TripState>, command: &TripCommand, ) -> Result<Applied<TripState, TripEvent>, DomainRejection>

Applies one command to one state, refusing it the way the real domain would. Must be deterministic and must not mutate state.

fn event_type(&self, event: &TripEvent) -> String

Stable event type label of an event, e.g. "trip.extra_added".

impl WorkflowDefinition for TripWorkflow

fn obligation_act( &self, state: Option<&TripState>, obligation: &TripObligation, ) -> Option<ObligationAct>

Each obligation as the question that closes it. An extra’s payer is asked of that extra: the answer gives only the payer.

fn narratable_state(&self, state: Option<&TripState>) -> Vec<StateField>

The values a person may be told back, which here is what they gave and the booking they gave it on; never the lifecycle or the ticket number.

fn briefing(&self, view: &ViewOf<Self>) -> Option<String>

Guidance that changes with the phase: while a case is being filled in, what a kept leg means; once the rebooking card is up, to read the message as an answer to it.

fn transition_briefing(&self, view: &ViewOf<Self>) -> Option<String>

What the sample wants said while it acknowledges and asks.

fn answer_briefing(&self, view: &ViewOf<Self>) -> Option<String>

And something else for the stage that answers.

fn artifacts(&self, view: &ViewOf<Self>) -> Vec<ArtifactRef>

The itinerary a quoted rebooking has, declared from the projection so it is there on a turn where the user asks instead of clicking.

fn confirmation_subject( &self, state: Option<&TripState>, _view: &ViewOf<Self>, act: &ResolvedAct, ) -> Option<ConfirmationSubject>

What the destructive confirmation is about, in words that name the thing.

fn enumerations(&self, _view: &ViewOf<Self>) -> Vec<DomainEnumeration>

The payers this workflow accepts, and no others.

fn next_steps( &self, state: Option<&TripState>, view: &ViewOf<Self>, ) -> Vec<NextStep>

A complete trip can take another extra, and the rebooking of the quoted leg once a quote is in; one still owing something offers nothing, because what it owes is asked first. The runtime offers a step only when its dry run on the record passes.

fn nothing_changed( &self, state: Option<&TripState>, act: &ResolvedAct, ) -> Option<LocalizedText>

Why nothing changed: the name already there.

type State = TripState

Persisted case state.

type Phase = TripPhase

Lifecycle phase.

type Obligation = TripObligation

Open obligation, possibly parameterized.

type Command = TripCommand

Typed command.

type Event = TripEvent

Typed domain event.

type Outcome = TripOutcome

Terminal outcome.

fn key(&self) -> WorkflowKey

Stable key.

fn version(&self) -> WorkflowVersion

Version; must change when projection semantics change (spec §8.4).

fn phase_ownership(&self, phase: &TripPhase) -> PhaseOwnership

Who must act in a phase. Drives the §8.4 invariants.

fn obligation_sentence( &self, obligation: &TripObligation, ) -> Option<LocalizedText>

One obligation, in words a person would recognise.

fn project(&self, case_ref: CaseRef, state: Option<&TripState>) -> ViewOf<Self>

Pure projection (I2).

fn summary(&self) -> Option<String>

One line saying what the workflow is for, shown when a message is split into requests. None, the default, shows the workflow’s key alone.

fn noun(&self) -> Option<LocalizedText>

What one record of this workflow is called, in each language its users speak («traveler», «viaggiatore»), for the sentences the runtime writes about one. None, the default, uses the workflow’s key.

fn glossary(&self) -> Vec<GlossaryTerm>

Terms this workflow’s users say, and what they mean here.

fn operations(&self, view: &ViewOf<Self>) -> Vec<OperationSpec>

The operations offered in this view, with their arguments, labels and examples.

fn record_operations(&self) -> Vec<OperationSpec>

Every operation a record of this workflow may offer, in any phase. Understanding is shown them while none of its records is in view, so a request for one is told there is none yet, and offered to open one, instead of going unread. The default is empty.

fn compile_act( &self, state: Option<&TripState>, _view: &ViewOf<Self>, act: &ResolvedAct, ) -> Result<Vec<TripCommand>, DomainRejection>

Compiles a resolved act into typed commands (spec §21.2).

fn command_policy( &self, state: Option<&TripState>, command: &TripCommand, ) -> CommandPolicy

Policy of a command. Unknown commands must default to CommandPolicy::conservative.

fn validate_command( &self, state: Option<&TripState>, command: &TripCommand, ) -> Result<(), DomainRejection>

Deterministic validation before execution.

fn state_after( &self, state: Option<&TripState>, command: &TripCommand, ) -> Option<TripState>

The state a valid command leaves state in, when the workflow can tell without executing it. An act on a record an earlier act of the same message opens is compiled and validated against the state the opening leaves; with None, the default, it is checked against no state, and a domain that needs the record refuses.

fn receipts( &self, events: &[ReceiptEvent<TripEvent>], locale: &Locale, ) -> Vec<OperationalReceipt>

Renders receipts from committed events (spec §17.3).

fn build_interaction( &self, state: Option<&TripState>, view: &ViewOf<Self>, requirement: &InteractionRequirement, ) -> Result<InteractionSpec, DomainRejection>

Turns a requirement of the view into a full interaction spec.

fn start_preconditions(&self) -> Vec<StartPrecondition>

What must already be true of another case before this workflow may be started.

fn start_behaviour(&self) -> StartBehaviour

What starting this workflow means when a case of it is already open.

fn may_open_beside( &self, open: &[WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>], ) -> Result<(), DomainRejection>

Whether a new case may be opened while open ones are: an operation aimed at a new record, the door StartBehaviour does not govern.

impl WorkflowModel<TripWorkflow> for TripModel

fn initial_states(&self) -> Vec<Option<TripState>>

The states exploration starts from. None means “the case does not exist yet”, which is where most workflows begin — and it never means “the case is over”, because a case’s identity outlives its content.

fn candidate_commands(&self, state: Option<&TripState>) -> Vec<TripCommand>

Commands worth trying in this state, in a stable order. Include commands you expect to be refused: the explorer checks that a refusal changes nothing.

fn simulate( &self, state: Option<&TripState>, command: &TripCommand, ) -> SimulatedTransition<TripState, TripEvent>

Applies one candidate command purely.

fn declared_outcomes(&self) -> Vec<TripOutcome>

Outcomes the workflow claims it can reach. The explorer reports every declared outcome no reachable state projects. The default is empty, which disables the check.