Enum CrowdError 

pub enum CrowdError {
    NonPositiveParam {
        model: &'static str,
        param: &'static str,
        value: f64,
    },
    NegativeParam {
        model: &'static str,
        param: &'static str,
        value: f64,
    },
    ZeroCount {
        model: &'static str,
        param: &'static str,
    },
    CflViolation {
        model: &'static str,
        product: f64,
        max_speed: f64,
        max_dt: f64,
    },
    InvalidDt {
        model: &'static str,
        dt: f64,
    },
}

Errors surfaced by rustsim-crowd parameter validation.

This enum is deliberately flat (no nested error types, no Box<dyn Error>) so callers can match on it exhaustively. Every variant carries the model name as its first field so a downstream error message tells the operator which model’s Params is misconfigured without having to walk a stack trace.

Variants

NonPositiveParam

A strictly-positive parameter was given a zero or negative value.

Fields

model: &'static str

Which model’s Params failed validation (e.g. "SocialForce").

param: &'static str

Name of the offending parameter (e.g. "mass", "tau").

value: f64

The actual value that was supplied.

NegativeParam

A non-negative parameter was given a negative value.

Fields

model: &'static str

Which model’s Params failed validation.

param: &'static str

Name of the offending parameter.

value: f64

The actual value that was supplied.

ZeroCount

A count-like parameter (number of candidates, number of directions) was given a zero value when it must be ≥ 1.

Fields

model: &'static str

Which model’s Params failed validation.

param: &'static str

Name of the offending parameter.

CflViolation

Explicit-Euler CFL-like condition violated.

For force-based models (Social Force, Generalized Centrifugal Force) the per-tick velocity change is bounded by dt * max_accel. If that bound exceeds max_speed the model relies entirely on the post-integration clamp_speed call to keep trajectories physical, which masks stiff interactions and hides numerical blow-ups.

Fields

model: &'static str

Which model’s Params failed validation.

product: f64

dt * max_accel for the offending configuration (m/s).

max_speed: f64

max_speed for the offending configuration (m/s).

max_dt: f64

The largest dt that satisfies dt * max_accel <= max_speed.

InvalidDt

dt is NaN, infinite, or non-positive.

Fields

model: &'static str

Which model’s Params was being validated.

dt: f64

The actual dt that was supplied.

Trait Implementations

impl Clone for CrowdError

fn clone(&self) -> CrowdError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrowdError

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

Formats the value using the given formatter.

impl Display for CrowdError

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

Formats the value using the given formatter.

impl Error for CrowdError

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 PartialEq for CrowdError

fn eq(&self, other: &CrowdError) -> 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 StructuralPartialEq for CrowdError