Struct WorkflowView 

pub struct WorkflowView<P, O, T> {
    pub case_ref: CaseRef,
    pub workflow_version: WorkflowVersion,
    pub phase: P,
    pub obligations: Vec<O>,
    pub blocking_interaction: Option<InteractionRequirement>,
    pub notices: Vec<WorkflowNotice>,
    pub outcome: Option<T>,
}

The pure projection of a case (spec §8.1).

Fields

case_ref: CaseRef

The case and the revision it was projected at.

workflow_version: WorkflowVersion

Version of the definition that produced the view.

phase: P

Exactly one lifecycle phase (I3).

obligations: Vec<O>

Every currently open obligation, possibly parameterized (I4), in the order the workflow wants them asked for.

A set is the truth about what is open and is what an index wants; it cannot say which one is being asked. Told to pick “the most useful one” a writer picks, and a collection flow was asked for its bank account first and its beneficiary second — the last question of the flow — and then read all six out as a menu. So the list is ordered by declaration and the writer is told to ask for the first.

Ordering rather than a single “current” obligation, because some domains genuinely have several open at once — a proposal reviewed in one answer, three extras with no payer that one message can close two of — and a shape that forced exactly one would make those unsayable.

blocking_interaction: Option<InteractionRequirement>

Zero or one blocking interaction requirement (I5, I6).

notices: Vec<WorkflowNotice>

Informational, non-blocking elements.

outcome: Option<T>

Present only when the workflow is complete.

Implementations

impl<P, O, T> WorkflowView<P, O, T>

pub fn new( case_ref: CaseRef, workflow_version: WorkflowVersion, phase: P, ) -> WorkflowView<P, O, T>

A view with a phase and nothing else.

pub fn with_obligations( self, obligations: impl IntoIterator<Item = O>, ) -> WorkflowView<P, O, T>

Adds obligations.

pub fn with_blocking_interaction( self, requirement: InteractionRequirement, ) -> WorkflowView<P, O, T>

Sets the blocking requirement.

pub fn with_notice(self, notice: WorkflowNotice) -> WorkflowView<P, O, T>

Adds a notice.

pub fn with_outcome(self, outcome: T) -> WorkflowView<P, O, T>

Sets the outcome.

pub fn is_complete(&self) -> bool

Returns true when an outcome is present.

pub fn has_obligations(&self) -> bool

Returns true when obligations remain.

impl<P, O, T> WorkflowView<P, O, T>

where P: Serialize, O: Serialize, T: Serialize,

pub fn erase( &self, ownership: PhaseOwnership, ) -> Result<ErasedWorkflowView, HashError>

Erases the generics into canonical JSON, attaching the phase ownership the definition declares.

Trait Implementations

impl<P, O, T> Clone for WorkflowView<P, O, T>

where P: Clone, O: Clone, T: Clone,

fn clone(&self) -> WorkflowView<P, O, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, O, T> Debug for WorkflowView<P, O, T>

where P: Debug, O: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<'de, P, O, T> Deserialize<'de> for WorkflowView<P, O, T>

where P: Deserialize<'de>, O: Deserialize<'de>, T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<WorkflowView<P, O, T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P, O, T> Eq for WorkflowView<P, O, T>

where P: Eq, O: Eq, T: Eq,

impl<P, O, T> PartialEq for WorkflowView<P, O, T>

where P: PartialEq, O: PartialEq, T: PartialEq,

fn eq(&self, other: &WorkflowView<P, O, T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<P, O, T> Serialize for WorkflowView<P, O, T>

where P: Serialize, O: Serialize, T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P, O, T> StructuralPartialEq for WorkflowView<P, O, T>

where P: PartialEq, O: PartialEq, T: PartialEq,