Enum Cause 

pub enum Cause {
    ControlC,
    Parent,
    Converged,
    ExceededMaxIterations,
}

Causes for termination of a solver

Variants

ControlC

The caller has manually terminated the process with ctrl-C

Parent

A parent thread had terminated the process using a [tokio::CancellationToken]

Converged

The solver has converged to the requested tolerance

ExceededMaxIterations

The solver has exceeded the maximum allowable iterations

Trait Implementations

impl Clone for Cause

fn clone(&self) -> Cause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cause

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cause

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cause

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Cause

impl Eq for Cause

impl StructuralPartialEq for Cause