Struct randomize::BoundedRandU32

pub struct BoundedRandU32 { /* fields omitted */ }

Stores the values to sample a number in 0 .. N

Making one of these performs a division operation. In comparison, Gen32::next_bounded will avoid needing to do a division much of the time. Thus, unless you need to sample repeatedly from a specific bounded range, simply calling next_bounded directly might be more efficient.

Implementations

impl BoundedRandU32

pub const fn new(count: u32) -> Self

Constructs a new BoundedRandU32.

Panics

If the count is 0.

pub const fn try_new(count: u32) -> Option<Self>

Constructs a new BoundedRandU32, or None on failure.

Failure

If the count is 0.

pub const fn count(self) -> u32

The number of possible outputs.

pub const fn place_in_range(self, val: u32) -> Option<u32>

Given a u32, place it into this bounded range.

Failure

• If the value is such that it doesn't fit evenly it is rejected.

pub fn sample<G: Gen32 + ?Sized>(self, gen: &mut G) -> u32

Given a gen, sample from the gen until place_in_range succeeds.

Trait Implementations

impl Clone for BoundedRandU32

fn clone(&self) -> BoundedRandU32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BoundedRandU32

impl Debug for BoundedRandU32

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

Formats the value using the given formatter.

impl Eq for BoundedRandU32

impl Hash for BoundedRandU32

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<BoundedRandU32> for BoundedRandU32

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

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

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

This method tests for !=.

impl StructuralEq for BoundedRandU32

impl StructuralPartialEq for BoundedRandU32