Enum BlockedOn 

pub enum BlockedOn<L: LabelId> {
    Send {
        to: RoleName,
        message_type: String,
    },
    Recv {
        from: RoleName,
        expected_types: Vec<String>,
    },
    Choice {
        branches: Vec<L>,
    },
    Offer {
        from: RoleName,
        branches: Vec<L>,
    },
    Complete,
    Failed(String),
}

What a protocol state machine is blocked on.

This enum describes what input is needed for the state machine to make progress.

Variants

Send

Waiting to send a message to a role.

Fields

to: RoleName

The destination role.

message_type: String

The message type being sent.

Recv

Waiting to receive a message from a role.

Fields

from: RoleName

The source role.

expected_types: Vec<String>

Expected message types (any of these is acceptable).

Choice

Waiting for an internal choice decision.

Fields

branches: Vec<L>

Available branch labels.

Offer

Waiting for an external choice (offer).

Fields

from: RoleName

The role making the choice.

branches: Vec<L>

Expected branch labels.

Complete

Protocol has completed successfully.

Failed(String)

Protocol has failed with an error.

Implementations

impl<L: LabelId> BlockedOn<L>

pub fn is_terminal(&self) -> bool

Check if the state machine is complete (successfully or with error).

pub fn is_send(&self) -> bool

Check if waiting to send.

pub fn is_recv(&self) -> bool

Check if waiting to receive.

pub fn is_choice(&self) -> bool

Check if waiting for a choice.

Trait Implementations

impl<L: Clone + LabelId> Clone for BlockedOn<L>

fn clone(&self) -> BlockedOn<L>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L: Debug + LabelId> Debug for BlockedOn<L>

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

Formats the value using the given formatter.

impl<L: PartialEq + LabelId> PartialEq for BlockedOn<L>

fn eq(&self, other: &BlockedOn<L>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<L: Eq + LabelId> Eq for BlockedOn<L>

impl<L: LabelId> StructuralPartialEq for BlockedOn<L>