Struct ArgumentError

pub struct ArgumentError(/* private fields */);

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

use spinoso_random::ArgumentError;

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

Implementations

impl ArgumentError

pub const fn new() -> Self

Construct a new, default argument error.

Examples

use spinoso_random::ArgumentError;

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

pub const fn domain_error() -> Self

Construct a new domain error.

Examples

use spinoso_random::ArgumentError;

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

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

Available on crate feature rand-method only.

Construct a new argument error from an invalid Max constraint.

Examples

use spinoso_random::{ArgumentError, Max};

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

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

use spinoso_random::ArgumentError;

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

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

use spinoso_random::ArgumentError;

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 duplicate of the value.

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

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

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<ArgumentError> for Error

fn from(err: ArgumentError) -> Self

Converts to this type from the input type.

impl PartialEq for ArgumentError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ArgumentError

impl StructuralPartialEq for ArgumentError