Enum ReturnCode 

pub enum ReturnCode {
    Success,
    MaxIters,
    Unstable,
    Terminated,
    Failure,
}

Why a solve stopped — the SciML ReturnCode vocabulary (esm-libraries-spec.md §2.5.3).

This REPLACES reading SolutionMetadata’s step and evaluation counters as a proxy for whether a run finished. The counters remain, as informative statistics; the answer to “did it reach tspan.1” is this enum and nothing else, and a caller never has to parse an error message to get it.

Variants

Success

The integration reached the end of tspan.

MaxIters

The integrator hit the configured SolveOptions::maxiters cap first. The trajectory returned is everything computed up to that point.

Unstable

The state left the finite range (a NaN or an infinity appeared), so the remaining trajectory would be meaningless.

Terminated

A callback or the progress observer asked the integrator to stop (Flow::Cancel). Nothing went wrong: it is the caller’s own decision.

Failure

The solver itself reported an error — a step failure, a build failure, a nonlinear-solve failure.

Implementations

impl ReturnCode

pub fn is_success(self) -> bool

Whether this is ReturnCode::Success — the one code that means the integration covered the whole of tspan.

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

The canonical SciML spelling, for display and for JSON hosts.

Trait Implementations

impl Clone for ReturnCode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReturnCode

impl Debug for ReturnCode

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

Formats the value using the given formatter.

impl Display for ReturnCode

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

Formats the value using the given formatter.

impl Eq for ReturnCode

impl PartialEq for ReturnCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReturnCode