Enum Error 

pub enum Error {
    InvalidHandle(u32),
    BodyNotFound(u32),
    ColliderNotFound(u32),
    InvalidParameter {
        name: String,
        message: String,
    },
    InvalidMass(f64),
    InvalidTimeStep(f64),
    InvalidDimension(f64),
    CapacityExceeded {
        max: usize,
    },
    SimulationDiverged {
        step: u64,
    },
    SolverConvergenceFailed {
        iterations: u32,
    },
    BodySleeping(u32),
    Serialization(String),
    SnapshotValidation(String),
    TypeError {
        expected: String,
        got: String,
    },
    MissingArgument(String),
    WrongArrayLength {
        expected: usize,
        got: usize,
    },
    General(String),
}

Comprehensive error type for the oxiphysics-python bridge.

Every failure mode has a dedicated variant to allow fine-grained handling from Python user code and for clean mapping to PyErr via PyO3.

Variants

InvalidHandle(u32)

A body or object handle was invalid.

BodyNotFound(u32)

A rigid body was not found by handle.

ColliderNotFound(u32)

A collider was not found by handle.

InvalidParameter

A named parameter was out of its valid range.

Fields

name: String

Parameter name.

message: String

Constraint description.

InvalidMass(f64)

A mass value was non-positive.

InvalidTimeStep(f64)

A time step was non-positive.

InvalidDimension(f64)

A geometry dimension was non-positive.

CapacityExceeded

The world has reached its maximum body capacity.

Fields

max: usize

Maximum allowed bodies.

SimulationDiverged

The simulation has diverged (NaN / Inf detected).

Fields

step: u64

Step at which divergence was detected.

SolverConvergenceFailed

The solver failed to converge.

Fields

iterations: u32

Iterations attempted.

BodySleeping(u32)

A body was queried but it is sleeping.

Serialization(String)

JSON serialization or deserialization failed.

SnapshotValidation(String)

Snapshot validation failed (schema mismatch, missing fields, etc.).

TypeError

A Python argument had an unexpected type.

Fields

expected: String

Expected Python type name.

got: String

Actual Python type name.

MissingArgument(String)

A required Python keyword argument was missing.

WrongArrayLength

A Python list or array had the wrong length.

Fields

expected: usize

Expected length.

got: usize

Actual length.

General(String)

Generic error with a free-form message.

Implementations

impl Error

pub fn invalid_param( name: impl Into<String>, message: impl Into<String>, ) -> Self

Create an InvalidParameter error.

pub fn general(msg: impl Into<String>) -> Self

Create a General error.

pub fn type_error(expected: impl Into<String>, got: impl Into<String>) -> Self

Create a TypeError error.

pub fn wrong_len(expected: usize, got: usize) -> Self

Create a WrongArrayLength error.

pub fn is_handle_error(&self) -> bool

Returns true if this error is handle-related.

pub fn is_parameter_error(&self) -> bool

Returns true if this error is a parameter validation error.

pub fn is_capacity_error(&self) -> bool

Returns true if this error is capacity-related.

pub fn is_stability_error(&self) -> bool

Returns true if this error indicates simulation instability.

pub fn is_serialization_error(&self) -> bool

Returns true if this is a serialization error.

pub fn is_type_error(&self) -> bool

Returns true if this is a Python interop type error.

pub fn to_json(&self) -> String

Serialize this error to a JSON string for Python exception chaining.

Example

use oxiphysics_python::Error;

let e = Error::InvalidTimeStep(-0.1);
let json = e.to_json();
assert!(json.contains("InvalidTimeStep"));

pub fn from_json(json: &str) -> Result<Self, String>

Deserialize an Error from JSON.

pub fn python_exception_class(&self) -> &'static str

Return a Python exception class name that best maps to this error.

Useful when calling PyO3’s PyErr::new::<PyXxx, _>().

pub fn recovery_hint(&self) -> String

Return a human-readable recovery hint for this error.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Error