Struct RecordBrief 

#[non_exhaustive]
pub struct RecordBrief {
    pub token: TargetToken,
    pub label: String,
    pub phase: String,
    pub fields: Vec<StateField>,
    pub obligations: Vec<String>,
    pub briefing: Option<String>,
    pub operations: Vec<OperationKey>,
}

A record in view.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

token: TargetToken

The token it is named by.

label: String

Server-authored label.

phase: String

Its phase, as the workflow names it.

fields: Vec<StateField>

What it holds, as the workflow says it may be stated.

obligations: Vec<String>

What it still needs, as sentences.

briefing: Option<String>

The workflow’s guidance for a turn about a record in this phase.

operations: Vec<OperationKey>

The operations offered on it now.

Implementations

impl RecordBrief

pub fn new( token: impl Into<TargetToken>, label: impl Into<String>, phase: impl Into<String>, ) -> Self

A record with its token, label and phase.

pub fn field(self, field: StateField) -> Self

Adds a field.

pub fn obligation(self, sentence: impl Into<String>) -> Self

Adds an open obligation.

pub fn briefing(self, briefing: impl Into<String>) -> Self

Sets the phase guidance.

pub fn offering<I, K>(self, operations: I) -> Self

where I: IntoIterator<Item = K>, K: Into<OperationKey>,

Offers operations on it.

pub fn offers(&self, operation: &OperationKey) -> bool

Whether operation is offered on it.

Trait Implementations

impl Clone for RecordBrief

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordBrief

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

Formats the value using the given formatter.