Enum CriticError 

#[non_exhaustive]
pub enum CriticError {
    NonFinite {
        field: CriticField,
        kind: NonFiniteKind,
    },
}

A checked assessment failed because a value was not finite.

Each error names the field that failed and whether the value was NaN or an infinity. Successful try_assess results have finite modulator fields in the critic’s documented ranges.

Example

use limbic_critic::{
    CriticError, CriticField, Environment, NonFiniteKind, SimpleCritic,
};

struct NanObjective;
impl Environment for NanObjective {
    fn objective(&self) -> f32 {
        f32::NAN
    }
}

let err = SimpleCritic::try_assess(&NanObjective).unwrap_err();
assert_eq!(
    err,
    CriticError::NonFinite {
        field: CriticField::Objective,
        kind: NonFiniteKind::Nan,
    }
);

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.

NonFinite

A raw observation or a computed intermediate was NaN or ±∞.

Fields

field: CriticField

Which input channel or intermediate failed validation.

kind: NonFiniteKind

Whether the value was NaN or an infinity.

Implementations

impl CriticError

pub fn from_non_finite(field: CriticField, value: f32) -> Option<Self>

Construct a NonFinite error from a non-finite f32.

Returns None when value is finite.

pub const fn field(&self) -> CriticField

The field or intermediate that failed validation.

pub const fn kind(&self) -> NonFiniteKind

Whether the rejected value was NaN or an infinity.

Trait Implementations

impl Clone for CriticError

fn clone(&self) -> CriticError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CriticError

impl Debug for CriticError

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

Formats the value using the given formatter.

impl Display for CriticError

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

Formats the value using the given formatter.

impl Eq for CriticError

impl Error for CriticError

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 CriticError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CriticError