Enum Error 

pub enum Error {
    General(String),
    GjkNoConverge {
        iterations: usize,
        dist: f64,
    },
    EpaFailure {
        reason: String,
    },
    CcdNoConverge {
        toi: f64,
        iters: usize,
    },
    DegenerateShape {
        detail: String,
    },
    IndexOutOfRange {
        index: usize,
        len: usize,
    },
    BroadphaseCapacity {
        capacity: usize,
    },
    NonFinite {
        context: String,
    },
    UnsupportedShapePair {
        shape_a: String,
        shape_b: String,
    },
}

Main error type for the collision module.

Variants

General(String)

Generic unclassified error message.

GjkNoConverge

A GJK query did not converge within the allowed iteration budget.

Fields

iterations: usize

Number of iterations attempted before giving up.

dist: f64

Remaining distance at termination.

EpaFailure

The EPA polytope expansion failed to find a valid separating face.

Fields

reason: String

Human-readable reason.

CcdNoConverge

Conservative-advancement CCD did not converge within the allowed budget.

Fields

toi: f64

Best TOI estimate when iterations were exhausted.

iters: usize

Number of iterations attempted.

DegenerateShape

A shape is degenerate (zero volume, zero radius, etc.).

Fields

detail: String

Description of the degeneracy.

IndexOutOfRange

An index (body, shape, node …) was out of range.

Fields

index: usize

The offending index.

len: usize

The valid range length.

BroadphaseCapacity

The broadphase structure has exceeded its capacity.

Fields

capacity: usize

Maximum capacity that was exceeded.

NonFinite

A numerical computation produced a non-finite value (NaN / Inf).

Fields

context: String

Where the non-finite was detected.

UnsupportedShapePair

The requested feature is not yet implemented for this shape combination.

Fields

shape_a: String

Name of shape A.

shape_b: String

Name of shape B.

Implementations

impl Error

pub fn kind(&self) -> ErrorKind

Return the coarse ErrorKind for this error.

pub fn is_convergence(&self) -> bool

Returns true when this error indicates a convergence failure.

pub fn is_numerical(&self) -> bool

Returns true when this error indicates a numerical problem.

pub fn is_bounds(&self) -> bool

Returns true when this error indicates an out-of-bounds access.

impl Error

pub fn severity(&self) -> Severity

Suggest a Severity level for this error.

pub fn is_severe(&self) -> bool

Returns true if the severity is at least Severity::Error.

impl Error

pub fn recovery_hint(&self) -> RecoveryHint

Suggest what the caller should do when encountering this error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

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.