Struct spinoso_random::ArgumentError
source · [−]pub struct ArgumentError(_);
Expand description
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
sourceimpl ArgumentError
impl ArgumentError
sourcepub const fn new() -> Self
pub const fn new() -> Self
Construct a new, default argument error.
Examples
const ERR: ArgumentError = ArgumentError::new();
assert_eq!(ERR.message(), "ArgumentError");
sourcepub const fn domain_error() -> Self
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");
sourcepub const fn with_rand_max(max: Max) -> Self
Available on crate feature random-rand
only.
pub const fn with_rand_max(max: Max) -> Self
random-rand
only.sourcepub const fn message(self) -> &'static str
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");
sourcepub const fn is_domain_error(self) -> bool
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
sourceimpl Clone for ArgumentError
impl Clone for ArgumentError
sourcefn clone(&self) -> ArgumentError
fn clone(&self) -> ArgumentError
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ArgumentError
impl Debug for ArgumentError
sourceimpl Display for ArgumentError
impl Display for ArgumentError
sourceimpl Error for ArgumentError
impl Error for ArgumentError
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl From<ArgumentError> for Error
impl From<ArgumentError> for Error
sourcefn from(err: ArgumentError) -> Self
fn from(err: ArgumentError) -> Self
Converts to this type from the input type.
sourceimpl PartialEq<ArgumentError> for ArgumentError
impl PartialEq<ArgumentError> for ArgumentError
sourcefn eq(&self, other: &ArgumentError) -> bool
fn eq(&self, other: &ArgumentError) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ArgumentError) -> bool
fn ne(&self, other: &ArgumentError) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ArgumentError> for ArgumentError
impl PartialOrd<ArgumentError> for ArgumentError
sourcefn partial_cmp(&self, other: &ArgumentError) -> Option<Ordering>
fn partial_cmp(&self, other: &ArgumentError) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for ArgumentError
impl StructuralPartialEq for ArgumentError
Auto Trait Implementations
impl RefUnwindSafe for ArgumentError
impl Send for ArgumentError
impl Sync for ArgumentError
impl Unpin for ArgumentError
impl UnwindSafe for ArgumentError
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more