Struct SecureRng

pub struct SecureRng { /* private fields */ }

A cryptographically secure random number generator.

The current implementation is ChaCha with 8 rounds, as supplied by the chacha20 crate.

Trait Implementations

impl Debug for SecureRng

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

Formats the value using the given formatter.

impl SecureYARandGenerator for SecureRng

fn fill_bytes(&mut self, dest: &mut [u8])

Fills dest with random data, which is safe to be used in cryptographic contexts.

fn text<E>(&mut self, len: usize) -> Option<String>

where E: Encoder,

Generates a random String with length len, using the provided Encoder to determine character set and minimum secure length. Since character sets can only contain valid ascii values, the length of the created String reprensents both the size of the String in bytes, and the amount of characters it contains.

impl YARandGenerator for SecureRng

fn try_new() -> Result<Self, Error>

Creates a generator using randomness provided by the OS.

fn u64(&mut self) -> u64

Returns a uniformly distributed u64 in the interval [0, 2⁶⁴).

fn new() -> Self

Creates a generator using randomness provided by the OS.

fn u32(&mut self) -> u32

Returns a uniformly distributed u32 in the interval [0, 2³²).

fn u16(&mut self) -> u16

Returns a uniformly distributed u16 in the interval [0, 2¹⁶).

fn u8(&mut self) -> u8

Returns a uniformly distributed u8 in the interval [0, 2⁸).

fn bits(&mut self, bit_count: u32) -> u64

Returns a uniformly distributed u64 in the interval [0, 2^bit_count).

fn bool(&mut self) -> bool

A simple coinflip, returning a bool that has a 50% chance of being true.

fn bound(&mut self, max: u64) -> u64

Returns a uniformly distributed u64 in the interval [0, max).

fn bound_inclusive(&mut self, max: u64) -> u64

Returns a uniformly distributed u64 in the interval [0, max].

fn range(&mut self, min: i64, max: i64) -> i64

Returns a uniformly distributed i64 in the interval [min, max)

fn range_inclusive(&mut self, min: i64, max: i64) -> i64

Returns a uniformly distributed i64 in the interval [min, max]

fn f64(&mut self) -> f64

Returns a uniformly distributed f64 in the interval [0.0, 1.0).

fn f32(&mut self) -> f32

Returns a uniformly distributed f32 in the interval [0.0, 1.0).

fn f64_nonzero(&mut self) -> f64

Returns a uniformly distributed f64 in the interval (0.0, 1.0].

fn f32_nonzero(&mut self) -> f32

Returns a uniformly distributed f32 in the interval (0.0, 1.0].

fn f64_wide(&mut self) -> f64

Returns a uniformly distributed f64 in the interval (-1.0, 1.0).

fn f32_wide(&mut self) -> f32

Returns a uniformly distributed f32 in the interval (-1.0, 1.0).

fn f64_normal(&mut self) -> (f64, f64)

Returns two indepedent and normally distributed f64 values with mean = 0.0 and stddev = 1.0.

fn f64_normal_distribution(&mut self, mean: f64, stddev: f64) -> (f64, f64)

Returns two indepedent and normally distributed f64 values with user-defined mean and stddev.

fn f64_exponential(&mut self) -> f64

Returns an exponentially distributed f64 with lambda = 1.0.

fn f64_exponential_lambda(&mut self, lambda: f64) -> f64

Returns an exponentially distributed f64 with user-defined lambda.

fn choose<C>(&mut self, collection: C) -> Option<C::Item>

where C: IntoIterator, C::IntoIter: ExactSizeIterator,

Returns a randomly chosen item from the iterator of collection.

fn ascii_alphabetic(&mut self) -> char

Returns a randomly selected ASCII alphabetic character.

fn ascii_uppercase(&mut self) -> char

Returns a randomly selected ASCII uppercase character.

fn ascii_lowercase(&mut self) -> char

Returns a randomly selected ASCII lowercase character.

fn ascii_alphanumeric(&mut self) -> char

Returns a randomly selected ASCII alphanumeric character.

fn ascii_digit(&mut self) -> char

Returns a randomly selected ASCII digit character.

fn shuffle<T>(&mut self, slice: &mut [T])

Performs a Fisher-Yates shuffle on the contents of slice.