Enum Config

#[non_exhaustive]
pub enum Config {
    Random,
    Deterministic,
    Seeded(<TestingRng as SeedableRng>::Seed),
}

Type describing a testing_rng configuration.

This is a separate type so that you can pick different defaults, or inspect the configuration before using it.

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.

Random

Use a PRNG with a randomly chosen seed.

Deterministic

Use a PRNG with a (default) pre-selected seed.

Seeded(<TestingRng as SeedableRng>::Seed)

Use a specific seed value for the PRNG.

Implementations

impl Config

pub fn from_env() -> Option<Self>

Return the testing PRNG from the environment, if one is configured.

Panics

Panics if the environment variable is set to an invalid value.

(If your code must not panic, then it is not test code, and you should not be using this function.)

fn from_env_result(var: Result<String, VarError>) -> Result<Option<Self>, Error>

Read the configuration from the result of std::env::var().

Return None if there was no option.

fn from_str(s: &str) -> Result<Self, Error>

Read the configuration from a provided string.

The string format is as described in testing_rng.

Return None if this string can’t be interpreted as a Config

fn into_seed(self) -> <TestingRng as SeedableRng>::Seed

Consume this Config and return a Seed.

pub fn into_rng(self) -> TestingRng

Consume this Config and return a TestingRng.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Copy for Config

impl Eq for Config

impl StructuralPartialEq for Config