Skip to main content

SimError

Enum SimError 

Source
pub enum SimError {
Show 15 variants NonFiniteValue { location: String, }, EnergyDrift { drift: f64, tolerance: f64, }, ConstraintViolation { name: String, violation: f64, tolerance: f64, }, Config { message: String, }, YamlParse(Error), Validation(ValidationErrors), CheckpointIntegrity, CheckpointNotFound(SimTime), Journal(String), Io(Error), Serialization(String), Physics(String), MonteCarlo(String), Optimization(String), HypothesisFalsified { reason: String, p_value: f64, },
}
Expand description

Unified error type for all simular operations.

§Design

Following Toyota’s Jidoka principle, errors are:

  1. Immediately detectable (type-safe)
  2. Self-documenting (descriptive variants)
  3. Actionable (contain recovery hints)

Variants§

§

NonFiniteValue

Numerical instability detected (NaN or Inf).

Fields

§location: String

Location where the non-finite value was detected.

§

EnergyDrift

Energy conservation violated beyond tolerance.

Fields

§drift: f64

Relative energy drift from initial state.

§tolerance: f64

Configured tolerance threshold.

§

ConstraintViolation

Constraint violation detected.

Fields

§name: String

Name of the violated constraint.

§violation: f64

Amount of violation.

§tolerance: f64

Configured tolerance.

§

Config

Invalid configuration parameter.

Fields

§message: String

Description of the configuration error.

§

YamlParse(Error)

YAML parsing error.

§

Validation(ValidationErrors)

Validation error.

§

CheckpointIntegrity

Checkpoint integrity violation.

§

CheckpointNotFound(SimTime)

Checkpoint not found.

§

Journal(String)

Journal read error.

§

Io(Error)

File I/O error.

§

Serialization(String)

Serialization error.

§

Physics(String)

Physics engine error.

§

MonteCarlo(String)

Monte Carlo error.

§

Optimization(String)

Optimization error.

§

HypothesisFalsified

Hypothesis falsified.

Fields

§reason: String

Reason for falsification.

§p_value: f64

Statistical p-value.

Implementations§

Source§

impl SimError

Source

pub fn config(message: impl Into<String>) -> Self

Create a configuration error with a message.

Source

pub fn serialization(message: impl Into<String>) -> Self

Create a serialization error.

Source

pub fn journal(message: impl Into<String>) -> Self

Create a journal error.

Source

pub fn optimization(message: impl Into<String>) -> Self

Create an optimization error.

Source

pub fn jidoka(message: impl Into<String>) -> Self

Create a Jidoka violation error (requires immediate stop).

Source

pub fn io(message: impl Into<String>) -> Self

Create an I/O error with a message (wraps in std::io::Error).

Source

pub const fn is_jidoka_violation(&self) -> bool

Check if this error is a Jidoka violation (requires immediate stop).

Trait Implementations§

Source§

impl Debug for SimError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SimError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for SimError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<Error> for SimError

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for SimError

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<JidokaViolation> for SimError

Source§

fn from(v: JidokaViolation) -> Self

Converts to this type from the input type.
Source§

impl From<ValidationErrors> for SimError

Source§

fn from(source: ValidationErrors) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ValidateIp for T
where T: ToString,

Source§

fn validate_ipv4(&self) -> bool

Validates whether the given string is an IP V4
Source§

fn validate_ipv6(&self) -> bool

Validates whether the given string is an IP V6
Source§

fn validate_ip(&self) -> bool

Validates whether the given string is an IP