Struct rand_core::block::BlockRng64

pub struct BlockRng64<R> where
    R: BlockRngCore + ?Sized,  {
    pub core: R,
    // some fields omitted
}

A wrapper type implementing RngCore for some type implementing BlockRngCore with u64 array buffer; i.e. this can be used to implement a full RNG from just a generate function.

This is similar to BlockRng, but specialized for algorithms that operate on u64 values.

No whole generated u64 values are thrown away and all values are consumed in-order. next_u64 simply takes the next available u64 value. next_u32 is however a bit special: half of a u64 is consumed, leaving the other half in the buffer. If the next function called is next_u32 then the other half is then consumed, however both next_u64 and fill_bytes discard the rest of any half-consumed u64s when called.

fill_bytes and try_fill_bytes consume a whole number of u64 values. If the requested length is not a multiple of 8, some bytes will be discarded.

Fields

core: R

The core part of the RNG, implementing the generate function.

Implementations

impl<R> BlockRng64<R> where
    R: BlockRngCore, 

pub fn new(core: R) -> BlockRng64<R>

Create a new BlockRng from an existing RNG implementing BlockRngCore. Results will be generated on first use.

pub fn index(&self) -> usize

Get the index into the result buffer.

If this is equal to or larger than the size of the result buffer then the buffer is "empty" and generate() must be called to produce new results.

pub fn reset(&mut self)

Reset the number of available results. This will force a new set of results to be generated on next use.

pub fn generate_and_set(&mut self, index: usize)

Generate a new set of results immediately, setting the index to the given value.

Trait Implementations

impl<R> Clone for BlockRng64<R> where
    R: BlockRngCore + Clone + ?Sized,
    <R as BlockRngCore>::Results: Clone, 

fn clone(&self) -> BlockRng64<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Debug for BlockRng64<R> where
    R: BlockRngCore + Debug, 

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

Formats the value using the given formatter.

impl<R> RngCore for BlockRng64<R> where
    R: BlockRngCore<Item = u64>,
    <R as BlockRngCore>::Results: AsRef<[u64]>,
    <R as BlockRngCore>::Results: AsMut<[u64]>, 

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.

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

Fill dest entirely with random data.

impl<R> SeedableRng for BlockRng64<R> where
    R: BlockRngCore + SeedableRng, 

type Seed = <R as SeedableRng>::Seed

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

fn from_seed(seed: <BlockRng64<R> as SeedableRng>::Seed) -> BlockRng64<R>

Create a new PRNG using the given seed.

fn seed_from_u64(seed: u64) -> BlockRng64<R>

Create a new PRNG using a u64 seed.

fn from_rng<S>(rng: S) -> Result<BlockRng64<R>, Error> where
    S: RngCore, 

Create a new PRNG seeded from another Rng.