Struct spinoso_env::ArgumentError

pub struct ArgumentError(_);

Error that indicates an argument parsing or value logic error occurred.

Argument errors have an associated message.

This error corresponds to the Ruby ArgumentError Exception class.

Examples

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

let err = ArgumentError::with_message(
    "bad environment variable name: contains null byte"
);
assert_eq!(err.message(), "bad environment variable name: contains null byte");

Implementations

impl ArgumentError

#[must_use]pub const fn new() -> Self

Construct a new, default argument error.

Examples

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

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

Construct a new, argument error with a message.

Examples

const ERR: ArgumentError = ArgumentError::with_message(
    "bad environment variable name: contains null byte"
);
assert_eq!(ERR.message(), "bad environment variable name: contains null byte");

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

Retrieve the exception message associated with this argument error.

Examples

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

let err = ArgumentError::with_message(
    "bad environment variable name: contains null byte"
);
assert_eq!(err.message(), "bad environment variable name: contains null byte");

Trait Implementations

impl Clone for ArgumentError

fn clone(&self) -> ArgumentError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ArgumentError

impl Debug for ArgumentError

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

Formats the value using the given formatter.

impl Default for ArgumentError

fn default() -> Self

Returns the "default value" for a type.

impl Display for ArgumentError

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

Formats the value using the given formatter.

impl Eq for ArgumentError

impl Error for ArgumentError

pub 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<&'static str> for ArgumentError

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

Performs the conversion.

impl From<ArgumentError> for Error

fn from(err: ArgumentError) -> Self

Performs the conversion.

impl Hash for ArgumentError

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 ArgumentError

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

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

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

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

This method tests for !=.

impl PartialOrd<ArgumentError> for ArgumentError

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ArgumentError

impl StructuralPartialEq for ArgumentError