Enum ChoreographyError 

pub enum ChoreographyError {
    Transport(String),
    Serialization(String),
    ChannelSendFailed {
        channel_type: &'static str,
        reason: String,
    },
    ChannelClosed {
        channel_type: &'static str,
        operation: &'static str,
    },
    NoPeerChannel {
        peer: String,
    },
    LabelSerializationFailed {
        operation: &'static str,
        reason: String,
    },
    MessageSerializationFailed {
        operation: &'static str,
        type_name: &'static str,
        reason: String,
    },
    Timeout(Duration),
    ProtocolViolation(String),
    UnknownRole(String),
    ProtocolContext {
        protocol: &'static str,
        role: &'static str,
        phase: &'static str,
        inner: Box<ChoreographyError>,
    },
    RoleContext {
        role: &'static str,
        index: Option<u32>,
        inner: Box<ChoreographyError>,
    },
    MessageContext {
        operation: &'static str,
        message_type: &'static str,
        direction: &'static str,
        other_role: &'static str,
        inner: Box<ChoreographyError>,
    },
    ChoiceError {
        role: &'static str,
        details: String,
    },
    WithContext {
        context: String,
        inner: Box<ChoreographyError>,
    },
    InvalidChoice {
        expected: Vec<String>,
        actual: String,
    },
    ExecutionError(String),
    EmptyRoleFamily(String),
    RoleFamilyNotFound(String),
    InvalidRoleRange {
        family: String,
        start: u32,
        end: u32,
    },
    InsufficientResponses {
        expected: usize,
        received: usize,
    },
    NotImplemented(String),
}

Errors that can occur during choreographic execution

Variants

Transport(String)

Transport-layer error (network, channel failure, etc.)

Serialization(String)

Message serialization/deserialization error

ChannelSendFailed

Session transport send operation failed.

Fields

channel_type: &'static str

Type of session transport (for example “SinkStream”)

reason: String

Human-readable failure reason

ChannelClosed

Session transport was closed unexpectedly during operation.

Fields

channel_type: &'static str

Type of session transport (for example “SinkStream”)

operation: &'static str

Operation being performed when channel closed

NoPeerChannel

No session registered for the specified peer.

Fields

peer: String

String representation of the peer role

LabelSerializationFailed

Label serialization failed during choice/offer

Fields

operation: &'static str

Operation: “serialization” or “deserialization”

reason: String

Human-readable failure reason

MessageSerializationFailed

Message serialization failed with type context

Fields

operation: &'static str

Operation: “Serialization” or “Deserialization”

type_name: &'static str

Name of the type being serialized

reason: String

Human-readable failure reason

Timeout(Duration)

Operation exceeded the specified timeout

ProtocolViolation(String)

Protocol specification was violated at runtime

UnknownRole(String)

Referenced role not found in the choreography

ProtocolContext

Error with protocol execution context

Wraps an inner error with information about where in the protocol the error occurred (protocol name, role, phase).

Fields

protocol: &'static str

Name of the protocol being executed

role: &'static str

Name of the role executing when error occurred

phase: &'static str

Current phase/step in the protocol

inner: Box<ChoreographyError>

The underlying error

RoleContext

Error with role-specific context

Fields

role: &'static str

Name of the role where error occurred

index: Option<u32>

Optional role index for parameterized roles

inner: Box<ChoreographyError>

The underlying error

MessageContext

Error during message exchange with another role

Fields

operation: &'static str

The operation being performed (send/recv)

message_type: &'static str

The type of message involved

direction: &'static str

Direction (to/from)

other_role: &'static str

The other role involved in the exchange

inner: Box<ChoreographyError>

The underlying error

ChoiceError

Error during choice/branch operation

Fields

role: &'static str

The role making or receiving the choice

details: String

Details about the choice error

WithContext

Generic wrapped error with context string

Fields

context: String

Additional context about the error

inner: Box<ChoreographyError>

The underlying error

InvalidChoice

Invalid choice: the chosen branch was not among expected options

Fields

expected: Vec<String>

Expected branch labels

actual: String

Actual branch label provided

ExecutionError(String)

General execution error

EmptyRoleFamily(String)

Role family is empty after resolution

RoleFamilyNotFound(String)

Role family not found in adapter

InvalidRoleRange

Role range is invalid

Fields

family: String

The role family name

start: u32

Range start (inclusive)

end: u32

Range end (exclusive)

InsufficientResponses

Insufficient responses received from role family

Fields

expected: usize

Expected minimum number of responses

received: usize

Actual number of responses received

NotImplemented(String)

Feature not implemented

Implementations

impl ChoreographyError

pub fn with_protocol_context( self, protocol: &'static str, role: &'static str, phase: &'static str, ) -> Self

Wrap this error with protocol context.

pub fn with_role_context(self, role: &'static str, index: Option<u32>) -> Self

Wrap this error with role context.

pub fn with_message_context( self, operation: &'static str, message_type: &'static str, direction: &'static str, other_role: &'static str, ) -> Self

Wrap this error with message exchange context.

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

Wrap this error with a generic context string.

pub fn root_cause(&self) -> &ChoreographyError

Get the root cause of the error (unwrapping all context layers).

pub fn is_timeout(&self) -> bool

Check if this error is a timeout.

pub fn is_transport(&self) -> bool

Check if this error is a transport error.

pub fn is_protocol_violation(&self) -> bool

Check if this error is a protocol violation.

pub fn is_serialization(&self) -> bool

Check if this error is a serialization error.

Trait Implementations

impl Debug for ChoreographyError

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

Formats the value using the given formatter.

impl Display for ChoreographyError

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

Formats the value using the given formatter.

impl Error for ChoreographyError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.