Enum DFRngError

#[non_exhaustive]
pub enum DFRngError {
    RngError(RngError),
}

Errors that can occur in DFRNG operations.

This enum represents the various errors that can occur when using the DFRNG library. It wraps errors from the random number generation module.

Examples

use darkforge_rng::rng::{UniformThreadRandom, RngError};
use darkforge_rng::DFRngError;

// This will fail because high < low
let err = UniformThreadRandom::<u8>::new(100, 1).expect_err("should have failed");
match err {
    DFRngError::RngError(e) => {
        // Handle the RNG error
        match e {
            RngError::InvalidDistribution(_) => {
                println!("Invalid distribution parameters");
            }
        }
    }
    _ => panic!("unexpected error type")
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RngError(RngError)

An error occurred in the random number generation.

This wraps errors from the rng module, such as invalid distribution parameters. See rng::RngError for more details on specific error types.

Trait Implementations

impl Debug for DFRngError

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

Formats the value using the given formatter.

impl Display for DFRngError

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

Formats the value using the given formatter.

impl Error for DFRngError

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<RngError> for DFRngError

fn from(source: RngError) -> Self

Converts to this type from the input type.

impl PartialEq for DFRngError

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

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

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 StructuralPartialEq for DFRngError