Struct FastRng

pub struct FastRng { /* private fields */ }

A FastRng struct implementing Random. you can initialize it with your own seed using FastRng::seed() Or if the std feature is enabled call FastRng::new() which will seed it with the system time.
For ergonomics and ease of usability the Rng is also provided as a global thread local variable using FastRng::local_rng()

Implementations

impl FastRng

pub fn new() -> Self

Creates a new instance of FastRng seeded with the system time.

Examples

use random_fast_rng::{FastRng, Random};

let mut rng = FastRng::new();
let random_u8 = rng.get_u8();
let arr: [u8; 32] = rng.gen();

pub fn seed(seed: u64, seq: u64) -> Self

A function to manually seed the Rng in no-std cases.

Trait Implementations

impl Random for FastRng

type Error = ()

The Error type, based on the source of randomness, non fallible sources can use Error=()

fn try_fill_bytes(&mut self, buf: &mut [u8]) -> Result<(), Self::Error>

This is the main method of the trait. You should implement this on your randomness source and will the buffer with random data.

fn get_u32(&mut self) -> u32

Returns a random u32 number.

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

Uses try_fill_bytes but panics if returns an error. Override if you can gracefully handle errors in the randomness source.

fn gen<T>(&mut self) -> T

where T: GenerateRand,

Returns a generic random value which implements GenerateRand

fn get_u8(&mut self) -> u8

Returns a random u8 number.

fn get_u16(&mut self) -> u16

Returns a random u16 number.

fn get_u64(&mut self) -> u64

Returns a random u64 number.

fn get_usize(&mut self) -> usize

Returns a random usize number.

fn get_u128(&mut self) -> u128

Returns a random u128 number.

fn get_bool(&mut self) -> bool

Returns a random bool with 50/50 probability.