Enum spinoso_math::Error

pub enum Error {
    Domain(DomainError),
    NotImplemented(NotImplementedError),
}

Sum type of all errors possibly returned from Math functions.

Math functions in spinoso-math return errors in the following conditions:

• The parameters evaluate to a result that is out of range.
• The function is not implemented due to missing compile-time flags.

Variants

Domain(DomainError)

Error that indicates a math function returned a value that was out of range.

This error can be used to differentiate between NaN inputs and what would be NaN outputs.

See DomainError.

NotImplemented(NotImplementedError)

Error that indicates a Math module function is not implemented.

See NotImplementedError.

Implementations

impl Error

#[must_use]pub const fn message(self) -> &'static str

Retrieve the exception message associated with this error.

Examples

let err = Error::from(DomainError::new());
assert_eq!(err.message(), "Math::DomainError");

let err = Error::from(NotImplementedError::with_message(
    "Artichoke was not built with Math::erf support"
));
assert_eq!(err.message(), "Artichoke was not built with Math::erf support");

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Error

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<DomainError> for Error

fn from(err: DomainError) -> Self

Performs the conversion.

impl From<NotImplementedError> for Error

fn from(err: NotImplementedError) -> Self

Performs the conversion.

impl Hash for Error

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Error

fn cmp(&self, other: &Error) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Error> for Error

fn partial_cmp(&self, other: &Error) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Error) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Error) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Error) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Error) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Error

impl StructuralPartialEq for Error