Enum ExecutionError

#[non_exhaustive]
pub enum ExecutionError {
    Halted,
    Terminated,
    Deadlock(Vec<DeadlockInfo>),
    MessageLoss(usize),
    NoRecipient {
        model: Option<String>,
    },
    Panic {
        model: String,
        payload: Box<dyn Any + Send + 'static>,
    },
    Timeout,
    OutOfSync(Duration),
    BadQuery,
    InvalidDeadline(MonotonicTime),
}

An error returned upon simulation execution failure.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Halted

The simulation has been intentionally interrupted with a call to Scheduler::halt.

The simulation remains in a well-defined state and can be resumed.

Terminated

The simulation has been terminated due to an earlier deadlock, message loss, missing recipient, model panic, timeout or synchronization loss.

Deadlock(Vec<DeadlockInfo>)

The simulation has deadlocked due to the enlisted models.

This is a fatal error: any subsequent attempt to run the simulation will return an ExecutionError::Terminated error.

MessageLoss(usize)

One or more message were left unprocessed because the recipient’s mailbox was not migrated to the simulation.

The payload indicates the number of lost messages.

This is a fatal error: any subsequent attempt to run the simulation will return an ExecutionError::Terminated error.

NoRecipient

The recipient of a message does not exists.

This indicates that the mailbox of the recipient of a message was not migrated to the simulation and was no longer alive when the message was sent.

This is a fatal error: any subsequent attempt to run the simulation will return an ExecutionError::Terminated error.

Fields

model: Option<String>

The fully qualified name of the model that attempted to send a message, or None if the message was sent from the scheduler.

The fully qualified name is made of the unqualified model name, if relevant prepended by the dot-separated names of all parent models.

Panic

A panic was caught during execution.

This is a fatal error: any subsequent attempt to run the simulation will return an ExecutionError::Terminated error.

Fields

model: String

The fully qualified name of the panicking model.

The fully qualified name is made of the unqualified model name, if relevant prepended by the dot-separated names of all parent models.

payload: Box<dyn Any + Send + 'static>

The payload associated with the panic.

The payload can be usually downcast to a String or &str. This is always the case if the panic was triggered by the panic! macro, but panics can in principle emit arbitrary payloads with e.g. panic_any.

Timeout

The simulation step has failed to complete within the allocated time.

This is a fatal error: any subsequent attempt to run the simulation will return an ExecutionError::Terminated error.

See also SimInit::set_timeout and Simulation::set_timeout.

OutOfSync(Duration)

The simulation has lost synchronization with the clock and lags behind by the duration given in the payload.

This is a fatal error: any subsequent attempt to run the simulation will return an ExecutionError::Terminated error.

See also SimInit::set_clock_tolerance.

BadQuery

The query did not obtain a response because the mailbox targeted by the query was not found in the simulation.

This is a non-fatal error.

InvalidDeadline(MonotonicTime)

The specified simulation deadline is in the past of the current simulation time.

This is a non-fatal error.

Trait Implementations

impl Debug for ExecutionError

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

Formats the value using the given formatter.

impl Display for ExecutionError

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

Formats the value using the given formatter.

impl Error for ExecutionError

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.

impl From<ExecutionError> for SimulationError

fn from(e: ExecutionError) -> Self

Converts to this type from the input type.