Struct spinoso_random::ArgumentError

pub struct ArgumentError(_);

Error that indicates a random number could not be generated with the given bounds.

This error is returned by rand(). See its documentation for more details.

This error corresponds to the Ruby ArgumentError Exception class.

Examples

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

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 domain_error() -> Self

Construct a new domain error.

Examples

const ERR: ArgumentError = ArgumentError::domain_error();
assert_eq!(ERR.message(), "Numerical argument out of domain");

#[must_use]

pub const fn with_rand_max(max: Max) -> Self

This is supported on crate feature random-rand only.

Construct a new argument error from an invalid Max constraint.

Examples

const ERR: ArgumentError = ArgumentError::with_rand_max(Max::Integer(-1));
assert_eq!(ERR.message(), "invalid argument");

#[must_use]

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

Retrieve the exception message associated with this new seed error.

Implementation notes

Argument errors constructed with ArgumentError::with_rand_max return an incomplete error message. Prefer to use the Display impl to retrieve error messages from ArgumentError.

Examples

let err = ArgumentError::new();
assert_eq!(err.message(), "ArgumentError");
let err = ArgumentError::domain_error();
assert_eq!(err.message(), "Numerical argument out of domain");

#[must_use]

pub const fn is_domain_error(self) -> bool

Return whether this argument error is a domain error.

Domain errors are typically reported as Errno::EDOM in MRI.

Examples

let err = ArgumentError::domain_error();
assert!(err.is_domain_error());
let err = ArgumentError::new();
assert!(!err.is_domain_error());

Trait Implementations

impl Clone for ArgumentError

fn clone(&self) -> ArgumentError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentError

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

Formats the value using the given formatter.

impl Display for ArgumentError

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

Formats the value using the given formatter.

impl Error for ArgumentError

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<ArgumentError> for Error

fn from(err: ArgumentError) -> Self

Performs the conversion.

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.

#[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 ArgumentError

impl StructuralPartialEq for ArgumentError