Struct spinoso_random::ArgumentError
source · pub struct ArgumentError(/* private fields */);
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
use spinoso_random::ArgumentError;
let err = ArgumentError::new();
assert_eq!(err.message(), "ArgumentError");
Implementations§
source§impl ArgumentError
impl ArgumentError
sourcepub const fn new() -> Self
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");
sourcepub const fn domain_error() -> Self
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");
sourcepub const fn with_rand_max(max: Max) -> Self
Available on crate feature rand-method
only.
pub const fn with_rand_max(max: Max) -> Self
rand-method
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
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");
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
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§
source§impl Clone for ArgumentError
impl Clone for ArgumentError
source§fn clone(&self) -> ArgumentError
fn clone(&self) -> ArgumentError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for ArgumentError
impl Debug for ArgumentError
source§impl Display for ArgumentError
impl Display for ArgumentError
source§impl Error for ArgumentError
impl Error for ArgumentError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<ArgumentError> for Error
impl From<ArgumentError> for Error
source§fn from(err: ArgumentError) -> Self
fn from(err: ArgumentError) -> Self
Converts to this type from the input type.
source§impl PartialEq for ArgumentError
impl PartialEq for ArgumentError
source§fn 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 ==
.source§impl PartialOrd for ArgumentError
impl PartialOrd for ArgumentError
source§fn partial_cmp(&self, other: &ArgumentError) -> Option<Ordering>
fn partial_cmp(&self, other: &ArgumentError) -> Option<Ordering>
1.0.0 · source§fn 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 moreimpl 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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more