Struct Choreography 

pub struct Choreography {
    pub name: String,
    /* private fields */
}

A global choreography specification.

Fields

name: String

Name of this choreography (e.g., “filter_update”).

Implementations

impl Choreography

pub fn new(name: impl Into<String>) -> Self

Create a new choreography with the given name.

pub fn step( &mut self, participant: impl Into<String>, action: Action, ) -> &mut Self

Add a step to the choreography.

pub fn steps(&self) -> &[ChoreographyStep]

Get all steps.

pub fn participants(&self) -> BTreeSet<ParticipantId>

Get all unique participants.

pub fn message_types(&self) -> BTreeSet<MessageType>

Get all message types used.

pub fn project(&self) -> Projection

Project the choreography to per-participant handlers.

pub fn verify_deadlock_free(&self) -> bool

Verify that the choreography is deadlock-free.

A choreography is deadlock-free if:

1. Every emitted message has at least one handler.
2. Every handled message has at least one emitter.
3. The message dependency graph is acyclic.

pub fn completeness_report(&self) -> CompletenessReport

Completeness check: are there unhandled messages or unmatched handlers?

Trait Implementations

impl Clone for Choreography

fn clone(&self) -> Choreography

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Choreography

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

Formats the value using the given formatter.