Enum StateError 

#[non_exhaustive]
pub enum StateError {
    TemplateRead {
        path: PathBuf,
        source: Error,
    },
    TemplateParse {
        path: PathBuf,
        source: Error,
    },
    EmptyFieldName {
        index: usize,
    },
    DuplicateField {
        field: String,
    },
    UnknownField {
        field: String,
    },
    RepeatedPayloadBorrow {
        field: String,
    },
    MissingPayload {
        field: String,
    },
    TypeMismatch {
        field: String,
        expected: &'static str,
        actual: &'static str,
    },
    IterationOverflow {
        iteration: u64,
    },
    MissingPhysicalTime {
        iteration: u64,
    },
    InvalidPhysicalAdvance {
        current: f64,
        delta: f64,
    },
}

A failure encountered while defining, accessing, or advancing a state.

StateError is non-exhaustive because later workflow features may add validation failures without forcing downstream crates to update exhaustive matches. Callers should match variants of interest and retain a fallback arm.

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.

TemplateRead

A JSON state template could not be read from the filesystem.

Fields

path: PathBuf

Path passed to the template loader.

source: Error

Underlying filesystem error.

TemplateParse

A state template was readable but did not contain valid JSON.

Fields

path: PathBuf

Path of the malformed template.

source: Error

Underlying JSON syntax or data-model error.

EmptyFieldName

A field definition used an empty or whitespace-only name.

Fields

index: usize

Zero-based position of the invalid field in template order.

DuplicateField

Two field definitions used the same name.

Fields

field: String

Repeated field name.

UnknownField

An operation addressed a key that is absent from the template layout.

Fields

field: String

Requested field name.

RepeatedPayloadBorrow

One coordinated borrow requested the same resolved field more than once.

Mutable aliases to one payload would violate Rust’s exclusivity rules. Immutable coordinated borrows reject the same input as well so SystemState::borrow_payloads and SystemState::borrow_payloads_mut retain identical, predictable request validation.

Fields

field: String

Field name at the first repeated tuple position.

MissingPayload

An operation required a payload from a declared but currently empty field.

Fields

field: String

Declared field whose slot is empty.

TypeMismatch

A typed operation requested a different Rust type from the retained field contract.

Fields

field: String

Field on which the typed operation was attempted.

expected: &'static str

Rust type requested by the caller.

actual: &'static str

Rust type bound to the field during state assembly.

IterationOverflow

Incrementing the authoritative iteration would overflow u64.

SystemState::advance_simulation_time will detect this condition before mutating the state, so the original time point remains unchanged.

Fields

iteration: u64

Current iteration that cannot be incremented.

MissingPhysicalTime

A physical-time delta was requested for a state without a physical coordinate.

Absence is not interpreted as zero: callers must establish a known origin explicitly before advancing physical time.

Fields

iteration: u64

Iteration at which physical advancement was requested.

InvalidPhysicalAdvance

A physical-time delta or its sum with the current coordinate is not finite.

Both operands are retained for diagnosis. This variant covers a non-finite input delta and finite operands whose addition overflows to infinity. The state remains unchanged.

Fields

current: f64

Current finite physical coordinate.

delta: f64

Requested delta, which may itself be non-finite.

Trait Implementations

impl Debug for StateError

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

Formats the value using the given formatter.

impl Display for StateError

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

Formats the value using the given formatter.

impl Error for StateError

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.