Struct BoundedUsize 

pub struct BoundedUsize<const MIN: usize, const MAX: usize>(/* private fields */);

A BoundedUsize` that’s bounded between two values (inclusive)

Implementations

impl<const MIN: usize, const MAX: usize> BoundedUsize<MIN, MAX>

pub fn new(num: usize) -> Result<Self, OutOfBoundsError<usize>>

Creates a new BoundedUsize from num.

Parameters

• num - The value to be validated and wrapped as a new bounded number.

Returns

• Ok(Self) if num is within MIN and MAX.
• Err(OutOfBoundsError) if num is outside MIN and MAX.

pub unsafe fn new_unchecked(num: usize) -> Self

Create a new clamped BoundedUsize (unchecked). Assumes num is already clamped between MIN and MAX (inclusive).

Parameters

• num - The value to be wrapped as a new bounded number. This must already be validated.

Returns

• Self - A new instance of the bounded number wrapping the provided value.

Safety

This function is marked unsafe because it assumes that num is already checked to be within the range from MIN to MAX (inclusive). The caller must ensure that this assumption is upheld.

pub fn into_inner(self) -> usize

Returns the value as a primitive type

Trait Implementations

impl<const MIN: usize, const MAX: usize> Clone for BoundedUsize<MIN, MAX>

fn clone(&self) -> BoundedUsize<MIN, MAX>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MIN: usize, const MAX: usize> Copy for BoundedUsize<MIN, MAX>

impl<const MIN: usize, const MAX: usize> Debug for BoundedUsize<MIN, MAX>

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

Formats the value using the given formatter.

impl<const MIN: usize, const MAX: usize> Display for BoundedUsize<MIN, MAX>

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

Formats the value using the given formatter.

impl<const MIN: usize, const MAX: usize> Eq for BoundedUsize<MIN, MAX>

impl<const MIN: usize, const MAX: usize> Hash for BoundedUsize<MIN, MAX>

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<const MIN: usize, const MAX: usize> Ord for BoundedUsize<MIN, MAX>

fn cmp(&self, other: &BoundedUsize<MIN, MAX>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const MIN: usize, const MAX: usize> PartialEq for BoundedUsize<MIN, MAX>

fn eq(&self, other: &BoundedUsize<MIN, MAX>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const MIN: usize, const MAX: usize> PartialOrd for BoundedUsize<MIN, MAX>

fn partial_cmp(&self, other: &BoundedUsize<MIN, MAX>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const MIN: usize, const MAX: usize> StructuralPartialEq for BoundedUsize<MIN, MAX>