Struct spinoso_math::NotImplementedError

pub struct NotImplementedError(_);

Error that indicates a Math module function is not implemented.

Some math functions are not available in the Rust core library and require this crate to be built with extra compile-time features to enable additional dependencies.

Not implemented errors have an associated message.

This error corresponds to the Ruby NotImplementedError Exception class.

Examples

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

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

Implementations

impl NotImplementedError

#[must_use]

pub const fn new() -> Self

Construct a new, default not implemented error.

Examples

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

#[must_use]

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

Construct a new, not implemented error with a message.

Examples

const ERR: NotImplementedError = NotImplementedError::with_message(
    "Artichoke was not built with Math::erf support"
);
assert_eq!(ERR.message(), "Artichoke was not built with Math::erf support");

#[must_use]

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

Retrieve the exception message associated with this not implemented error.

Examples

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

let err = 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 NotImplementedError

fn clone(&self) -> NotImplementedError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotImplementedError

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

Formats the value using the given formatter.

impl Default for NotImplementedError

fn default() -> NotImplementedError

Returns the “default value” for a type.

impl Display for NotImplementedError

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

Formats the value using the given formatter.

impl Error for NotImplementedError

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 NotImplementedError

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

Performs the conversion.

impl From<NotImplementedError> for Error

fn from(err: NotImplementedError) -> Self

Performs the conversion.

impl Hash for NotImplementedError

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 NotImplementedError

fn cmp(&self, other: &NotImplementedError) -> 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<NotImplementedError> for NotImplementedError

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

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

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

This method tests for !=.

impl PartialOrd<NotImplementedError> for NotImplementedError

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

impl Eq for NotImplementedError

impl StructuralEq for NotImplementedError

impl StructuralPartialEq for NotImplementedError