Enum PykepError 

#[non_exhaustive]
pub enum PykepError {
    InvalidInput {
        parameter: &'static str,
        reason: String,
    },
    NonFiniteInput {
        parameter: &'static str,
    },
    SingularGeometry {
        operation: &'static str,
    },
    ConvergenceFailure {
        operation: &'static str,
        iterations: usize,
    },
    DimensionMismatch {
        expected: usize,
        actual: usize,
    },
    UnsupportedCapability {
        provider: String,
        capability: &'static str,
    },
    NumericalOverflow {
        operation: &'static str,
    },
    IntegrationFailure {
        model: &'static str,
        reason: String,
    },
    DataUnavailable {
        dataset: &'static str,
    },
}

Error returned by a pykep numerical operation.

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.

InvalidInput

A finite input lies outside the mathematical domain.

Fields

parameter: &'static str

Public parameter name.

reason: String

Human-readable domain requirement.

NonFiniteInput

A public input is NaN or infinite.

Fields

parameter: &'static str

Public parameter name.

SingularGeometry

The requested operation is undefined for the supplied geometry.

Fields

operation: &'static str

Operation that detected the singularity.

ConvergenceFailure

An iterative algorithm exhausted its iteration limit.

Fields

operation: &'static str

Iterative operation that failed.

iterations: usize

Number of iterations attempted.

DimensionMismatch

A dynamically sized value has an invalid length.

Fields

expected: usize

Required number of scalar values.

actual: usize

Supplied number of scalar values.

UnsupportedCapability

An ephemeris or backend does not implement a requested capability.

Fields

provider: String

Provider or backend name.

capability: &'static str

Unsupported capability name.

NumericalOverflow

A finite input produced a value outside the binary64 range.

Fields

operation: &'static str

Numerical operation that overflowed.

IntegrationFailure

A numerical integrator could not complete a propagation.

Fields

model: &'static str

Dynamics model being integrated.

reason: String

Human-readable failure context.

DataUnavailable

A required embedded or external dataset is unavailable or corrupt.

Fields

dataset: &'static str

Stable dataset name.

Trait Implementations

impl Clone for PykepError

fn clone(&self) -> PykepError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PykepError

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

Formats the value using the given formatter.

impl Display for PykepError

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

Formats the value using the given formatter.

impl Eq for PykepError

impl Error for PykepError

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 PykepError

fn eq(&self, other: &PykepError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PykepError