Struct randomize::BoundedRandU16

pub struct BoundedRandU16 { /* private fields */ }

Allows sampling a u16 number in 0 .. N.

The primary advantage of this type over BoundedRandU32 is that this type samples using only 32-bit multiplications rather than 64-bit multiplications, so on a 32-bit CPU this will perform much faster.

Implementations

impl BoundedRandU16

pub const _4: Self = _

pub const _6: Self = _

pub const _8: Self = _

pub const _10: Self = _

pub const _12: Self = _

pub const _20: Self = _

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

Constructs a new value.

Panics

If the count is 0.

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

Constructs a new value, or None on failure.

Failure

If the count is 0.

pub const fn count(self) -> u16

The number of possible outputs.

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

Given a u16, try to place it into this bounded range.

Failure

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

pub fn sample<F: FnMut() -> u16>(self, f: F) -> u16

Given a generator function, call it until place_in_range succeeds.

Trait Implementations

impl Clone for BoundedRandU16

fn clone(&self) -> BoundedRandU16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundedRandU16

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

Formats the value using the given formatter.

impl Hash for BoundedRandU16

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<BoundedRandU16> for BoundedRandU16

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

impl Eq for BoundedRandU16

impl StructuralEq for BoundedRandU16

impl StructuralPartialEq for BoundedRandU16