Struct rand::rngs::mock::StepRng

pub struct StepRng { /* private fields */ }

A mock generator yielding very predictable output

This generates an arithmetic sequence (i.e. adds a constant each step) over a u64 number, using wrapping arithmetic. If the increment is 0 the generator yields a constant.

Other integer types (64-bit and smaller) are produced via cast from u64.

Other types are produced via their implementation of Rng or Distribution. Output values may not be intuitive and may change in future releases but are considered portable. (bool output is true when bit 1u64 << 31 is set.)

Example

use rand::Rng;
use rand::rngs::mock::StepRng;

let mut my_rng = StepRng::new(2, 1);
let sample: [u64; 3] = my_rng.gen();
assert_eq!(sample, [2, 3, 4]);

Implementations

impl StepRng

pub fn new(initial: u64, increment: u64) -> Self

Create a StepRng, yielding an arithmetic sequence starting with initial and incremented by increment each time.

Trait Implementations

impl Clone for StepRng

fn clone(&self) -> StepRng

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StepRng

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StepRng

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StepRng

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

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.

fn read_adapter(&mut self) -> RngReadAdapter<'_, Self>

where Self: Sized,

Convert an RngCore to a RngReadAdapter.

impl Serialize for StepRng

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StepRng

impl StructuralPartialEq for StepRng