Struct rand::rngs::mock::StepRng

source · [−]

pub struct StepRng { /* private fields */ }

Expand description

A simple implementation of RngCore for testing purposes.

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.

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

source

impl StepRng

source

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

source

impl Clone for StepRng

source

fn clone(&self) -> StepRng

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for StepRng

source

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

Formats the value using the given formatter. Read more

source

impl RngCore for StepRng

source

fn next_u32(&mut self) -> u32

Return the next random u32. Read more

source

fn next_u64(&mut self) -> u64

Return the next random u64. Read more

source

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

Fill dest with random data. Read more

source

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

Fill dest entirely with random data. Read more

Auto Trait Implementations

impl RefUnwindSafe for StepRng

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<R> Rng for R where
R: RngCore + ?Sized,

source

fn gen<T>(&mut self) -> T where
Standard: Distribution<T>,

Return a random value supporting the Standard distribution. Read more

source

fn gen_range<T: SampleUniform, B1, B2>(&mut self, low: B1, high: B2) -> T where
B1: SampleBorrow<T> + Sized,
B2: SampleBorrow<T> + Sized,

Generate a random value in the range [low, high), i.e. inclusive of low and exclusive of high. Read more

source

fn sample<T, D: Distribution<T>>(&mut self, distr: D) -> T

Sample a new value, using the given distribution. Read more

source

fn sample_iter<'a, T, D: Distribution<T>>(
 &'a mut self,
 distr: &'a D
) -> DistIter<'a, D, Self, T>ⓘNotable traits for DistIter<'a, D, R, T>`impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where D: Distribution<T>, R: Rng + 'a, type Item = T;` where
 Self: Sized,

Create an iterator that generates values using the given distribution. Read more

source

fn fill<T: AsByteSliceMut + ?Sized>(&mut self, dest: &mut T)

Fill dest entirely with random bytes (uniform value distribution), where dest is any type supporting AsByteSliceMut, namely slices and arrays over primitive integer types (i8, i16, u32, etc.). Read more

source

fn try_fill<T: AsByteSliceMut + ?Sized>(
&mut self,
dest: &mut T
) -> Result<(), Error>

Fill dest entirely with random bytes (uniform value distribution), where dest is any type supporting AsByteSliceMut, namely slices and arrays over primitive integer types (i8, i16, u32, etc.). Read more

source

fn gen_bool(&mut self, p: f64) -> bool

Return a bool with a probability p of being true. Read more

source

fn gen_ratio(&mut self, numerator: u32, denominator: u32) -> bool

Return a bool with a probability of numerator/denominator of being true. I.e. gen_ratio(2, 3) has chance of 2 in 3, or about 67%, of returning true. If numerator == denominator, then the returned value is guaranteed to be true. If numerator == 0, then the returned value is guaranteed to be false. Read more

source

fn choose<'a, T>(&mut self, values: &'a [T]) -> Option<&'a T>

👎 Deprecated since 0.6.0:

use SliceRandom::choose instead

Return a random element from values. Read more

source

fn choose_mut<'a, T>(&mut self, values: &'a mut [T]) -> Option<&'a mut T>

👎 Deprecated since 0.6.0:

use SliceRandom::choose_mut instead

Return a mutable pointer to a random element from values. Read more

source

fn shuffle<T>(&mut self, values: &mut [T])

👎 Deprecated since 0.6.0:

use SliceRandom::shuffle instead

Shuffle a mutable slice in place. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rand::rngs::mock::StepRng

Implementations

impl StepRng

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

Trait Implementations

impl Clone for StepRng

fn clone(&self) -> StepRng

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

impl Debug for StepRng

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

impl RngCore for StepRng

fn next_u32(&mut self) -> u32

fn next_u64(&mut self) -> u64

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

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

Auto Trait Implementations

impl RefUnwindSafe for StepRng

impl Send for StepRng

impl Sync for StepRng

impl Unpin for StepRng

impl UnwindSafe for StepRng

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<R> Rng for R where R: RngCore + ?Sized,

fn gen<T>(&mut self) -> T where Standard: Distribution<T>,

fn gen_range<T: SampleUniform, B1, B2>(&mut self, low: B1, high: B2) -> T where B1: SampleBorrow<T> + Sized, B2: SampleBorrow<T> + Sized,

fn sample<T, D: Distribution<T>>(&mut self, distr: D) -> T

fn sample_iter<'a, T, D: Distribution<T>>( &'a mut self, distr: &'a D) -> DistIter<'a, D, Self, T>ⓘNotable traits for DistIter<'a, D, R, T>impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where D: Distribution<T>, R: Rng + 'a, type Item = T; where Self: Sized,

fn fill<T: AsByteSliceMut + ?Sized>(&mut self, dest: &mut T)

fn try_fill<T: AsByteSliceMut + ?Sized>( &mut self, dest: &mut T) -> Result<(), Error>

fn gen_bool(&mut self, p: f64) -> bool

fn gen_ratio(&mut self, numerator: u32, denominator: u32) -> bool

fn choose<'a, T>(&mut self, values: &'a [T]) -> Option<&'a T>

fn choose_mut<'a, T>(&mut self, values: &'a mut [T]) -> Option<&'a mut T>

fn shuffle<T>(&mut self, values: &mut [T])

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<R> Rng for R where
R: RngCore + ?Sized,

fn gen<T>(&mut self) -> T where
Standard: Distribution<T>,

fn gen_range<T: SampleUniform, B1, B2>(&mut self, low: B1, high: B2) -> T where
B1: SampleBorrow<T> + Sized,
B2: SampleBorrow<T> + Sized,

fn sample_iter<'a, T, D: Distribution<T>>(
&'a mut self,
distr: &'a D
) -> DistIter<'a, D, Self, T>ⓘNotable traits for DistIter<'a, D, R, T>`impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where D: Distribution<T>, R: Rng + 'a, type Item = T;` where
Self: Sized,

fn try_fill<T: AsByteSliceMut + ?Sized>(
&mut self,
dest: &mut T
) -> Result<(), Error>

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,