Struct spinoso_securerandom::DomainError

pub struct DomainError { /* fields omitted */ }

Error that indicates the given maximum value is not finite and cannot be used to bound a domain for generating random numbers.

This error is returned by random_number.

Implementations

impl DomainError

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

Construct a new, default domain error.

Examples

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

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

Retrieve the exception message associated with this domain error.

Examples

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

Trait Implementations

impl Clone for DomainError

fn clone(&self) -> DomainError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DomainError

impl Debug for DomainError

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

Formats the value using the given formatter.

impl Display for DomainError

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

Formats the value using the given formatter.

impl Eq for DomainError

impl Error for DomainError

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 Hash for DomainError

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 DomainError

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

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

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

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

This method tests for !=.

impl PartialOrd<DomainError> for DomainError

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for DomainError

impl StructuralPartialEq for DomainError