Struct spinoso_math::DomainError

pub struct DomainError(_);

Error that indicates a math function evaluated to an out of range value.

Domain errors have an associated message.

This error corresponds to the Ruby Math::DomainError Exception class. It can be used to differentiate between NaN inputs and what would be NaN outputs.

Examples

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

let err = DomainError::with_message(
    r#"Numerical argument is out of domain - "acos""#,
);
assert_eq!(err.message(), r#"Numerical argument is out of domain - "acos""#);

Implementations

impl DomainError

#[must_use]

pub const fn new() -> Self

Construct a new, default domain error.

Examples

const ERR: DomainError = DomainError::new();
assert_eq!(ERR.message(), "Math::DomainError");

#[must_use]

pub const fn with_message(message: &'static str) -> Self

Construct a new, domaine error with a message.

Examples

const ERR: DomainError = DomainError::with_message(
    r#"Numerical argument is out of domain - "acos""#,
);
assert_eq!(ERR.message(), r#"Numerical argument is out of domain - "acos""#);

#[must_use]

pub const fn message(self) -> &'static str

Retrieve the exception message associated with this error.

Examples

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

let err = DomainError::with_message(
    r#"Numerical argument is out of domain - "acos""#,
);
assert_eq!(err.message(), r#"Numerical argument is out of domain - "acos""#);

Trait Implementations

impl Clone for DomainError

fn clone(&self) -> DomainError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainError

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

Formats the value using the given formatter.

impl Default for DomainError

fn default() -> DomainError

Returns the “default value” for a type.

impl Display for DomainError

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

Formats the value using the given formatter.

impl Error for DomainError

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

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

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

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

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

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

impl From<&'static str> for DomainError

fn from(message: &'static str) -> Self

Performs the conversion.

impl From<DomainError> for Error

fn from(err: DomainError) -> Self

Performs the conversion.

impl Hash for DomainError

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

Feeds this value into the given Hasher.

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 DomainError

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

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DomainError> for DomainError

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

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

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

This method tests for !=.

impl PartialOrd<DomainError> for DomainError

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl Copy for DomainError

impl Eq for DomainError

impl StructuralEq for DomainError

impl StructuralPartialEq for DomainError