Struct XorShiftRng

pub struct XorShiftRng { /* private fields */ }

An Xorshift random number generator.

The Xorshift¹ algorithm is not suitable for cryptographic purposes but is very fast. If you do not know for sure that it fits your requirements, use a more secure one such as StdRng or OsRng.

When seeded with zero (i.e. XorShiftRng::from_seed(0) is called), this implementation actually uses 0xBAD_5EED_0BAD_5EED_0BAD_5EED_0BAD_5EED for the seed. This arbitrary value is used because the underlying algorithm can’t escape from an all-zero state, and the function is infallible so it can’t signal this by returning an error.

---

1. Marsaglia, George (July 2003). “Xorshift RNGs”. Journal of Statistical Software. Vol. 8 (Issue 14). ↩

Trait Implementations

impl Clone for XorShiftRng

fn clone(&self) -> XorShiftRng

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XorShiftRng

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

Formats the value using the given formatter.

impl PartialEq for XorShiftRng

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

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

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

Fill dest with random data.

impl SeedableRng for XorShiftRng

type Seed = [u8; 16]

Seed type, which is restricted to types mutably-dereferenceable as u8 arrays (we recommend [u8; N] for some N).

fn from_seed(seed: Self::Seed) -> Self

Create a new PRNG using the given seed.

fn from_rng(rng: &mut impl RngCore) -> Self

Create a new PRNG seeded from an infallible Rng.

fn try_from_rng<R: TryRngCore>(rng: &mut R) -> Result<Self, R::Error>

Create a new PRNG seeded from a potentially fallible Rng.

fn seed_from_u64(state: u64) -> Self

Create a new PRNG using a u64 seed.

fn from_os_rng() -> Self

Creates a new instance of the RNG seeded via getrandom.

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

Creates a new instance of the RNG seeded via getrandom without unwrapping potential getrandom errors.

impl Eq for XorShiftRng

impl StructuralPartialEq for XorShiftRng