Struct tinyrand_alloc::mock::Mock

pub struct Mock<'d> { /* private fields */ }

Mock RNG, containing invocation state and delegate closures.

Implementations

impl<'d> Mock<'d>

pub fn with_next_u128(self, delegate: impl FnMut(&State) -> u128 + 'd) -> Self

Assigns a Rand::next_u128 delegate to the mock. I.e., when the Rand::next_u128 method is invoked on the mock (directly, or via another method), it will delegate to the given closure.

Examples

use tinyrand::Rand;
use tinyrand_alloc::Mock;
let mut mock = Mock::default()
    .with_next_u128(|_| 42);
assert_eq!(42, mock.next_usize());
assert_eq!(42, mock.next_u64());
assert_eq!(42, mock.next_u128());

pub fn with_next_bool(
    self,
    delegate: impl FnMut(Surrogate<'_, '_>, Probability) -> bool + 'd
) -> Self

Assigns a Rand::next_bool delegate to the mock. I.e., when the Rand::next_bool method is invoked on the mock, it will delegate to the given closure.

Examples

use tinyrand::{Probability, Rand};
use tinyrand_alloc::Mock;
let mut mock = Mock::default()
    .with_next_bool(|_, _| true);
assert!(mock.next_bool(Probability::new(0.01)));

pub fn with_next_lim_u128(
    self,
    delegate: impl FnMut(Surrogate<'_, '_>, u128) -> u128 + 'd
) -> Self

Assigns a Rand::next_lim_u128 delegate to the mock. I.e., when the Rand::next_lim_u128 method is invoked on the mock, it will delegate to the given closure. This delegate can be used to effectively mock Rand::next_lim and Rand::next_range methods.

Examples

use tinyrand::{Rand, RandRange};
use tinyrand_alloc::Mock;
let mut mock = Mock::default()
    .with_next_lim_u128(|_, _| 17);
assert_eq!(17, mock.next_lim_u64(66));
assert_eq!(27, mock.next_range(10..100u16));

pub fn state(&self) -> &State

Obtains the underlying mock state.

Trait Implementations

impl<'a> Default for Mock<'a>

fn default() -> Self

Returns the “default value” for a type.

impl Rand for Mock<'_>

fn next_u128(&mut self) -> u128

Delegates to the underlying closure and increments the state.next_u128_invocations counter after the closure returns.

fn next_bool(&mut self, p: Probability) -> bool

Delegates to the underlying closure and increments the state.next_bool_invocations counter after the closure returns.

fn next_lim_u128(&mut self, lim: u128) -> u128

Delegates to the underlying closure and increments the state.next_lim_u128_invocations counter after the closure returns.

fn next_u64(&mut self) -> u64

Returns the next random u64.

fn next_lim_u16(&mut self, lim: u16) -> u16

Generates a random number in 0..lim.

fn next_lim_u32(&mut self, lim: u32) -> u32

Generates a random number in 0..lim.

fn next_lim_u64(&mut self, lim: u64) -> u64

Generates a random number in 0..lim.

fn next_u16(&mut self) -> u16

Returns the next random u16.

fn next_u32(&mut self) -> u32

Returns the next random u32.

fn next_usize(&mut self) -> usize

Returns the next random usize.

fn next_lim_usize(&mut self, lim: usize) -> usize

Generates a random number in 0..lim.