Struct bones_framework::lib::prelude::bones_schema::prelude::bones_utils::prelude::rng::Rng

pub struct Rng(/* private fields */);

A Random Number generator, powered by the WyRand algorithm.

Implementations

impl Rng

pub fn new() -> Rng

Creates a new Rng with a randomised seed.

pub fn reseed_local(seed: u64)

Reseeds the current thread-local generator.

Trait Implementations

impl Clone for Rng

fn clone(&self) -> Rng

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rng

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

Formats the value using the given formatter.

impl Default for Rng

fn default() -> Rng

Initialises a default instance of Rng. Warning, the default is seeded with a randomly generated state, so this is not deterministic.

Example

use turborand::prelude::*;

let rng1 = Rng::default();
let rng2 = Rng::default();

assert_ne!(rng1.u64(..), rng2.u64(..));

impl ForkableCore for Rng

fn fork(&self) -> Rng

Forks a TurboCore instance by deterministically deriving a new instance based on the initial seed.

impl GenCore for Rng

const GEN_KIND: TurboKind = TurboKind::FAST

Determines the kind of PRNG. TurboKind::FAST RNGs are meant to be very quick, non-cryptographic PRNGs, while TurboKind::SLOW are slower, more expensive PRNGs, usually CSPRNGs but not always. Setting this constant allows for certain algorithms to be toggled for tuning performance of certain methods.

fn gen<const SIZE: usize>(&self) -> [u8; SIZE]

Returns an array of constant SIZE containing random u8 values.

fn gen_u128(&self) -> u128

Returns a random u128 value.

fn gen_i128(&self) -> i128

Returns a random i128 value.

fn gen_u64(&self) -> u64

Returns a random u64 value.

fn gen_i64(&self) -> i64

Returns a random i64 value.

fn gen_u32(&self) -> u32

Returns a random u32 value.

fn gen_i32(&self) -> i32

Returns a random i32 value.

fn gen_u16(&self) -> u16

Returns a random u16 value.

fn gen_i16(&self) -> i16

Returns a random i16 value.

fn gen_u8(&self) -> u8

Returns a random u8 value.

fn gen_i8(&self) -> i8

Returns a random i8 value.

fn gen_usize(&self) -> usize

Returns a random usize value.

fn gen_isize(&self) -> isize

Returns a random isize value.

impl PartialEq for Rng

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SeededCore for Rng

type Seed = u64

Associated type for accepting valid Seed values. Must be Sized.

fn with_seed(seed: <Rng as SeededCore>::Seed) -> Rng

Creates a new SeededCore with a specific seed value.

fn reseed(&self, seed: <Rng as SeededCore>::Seed)

Reseeds the SeededCore with a new seed/state.

impl TurboCore for Rng

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

Fills a mutable buffer with random bytes.

impl Eq for Rng

impl StructuralEq for Rng

impl StructuralPartialEq for Rng