Struct InRange

pub struct InRange<const A: usize, const B: usize>(/* private fields */);

A usize value that is guaranteed to be in the range A..B.

Common methods are in the InRangeBounds trait implementation.

Trait Implementations

impl<const A: usize, const B: usize> Clone for InRange<A, B>

fn clone(&self) -> InRange<A, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const A: usize, const B: usize> Debug for InRange<A, B>

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

Formats the value using the given formatter.

impl<const A: usize, const B: usize> Finite for InRange<A, B>

const INHABITANTS: usize = <Self as InRangeBounds>::INHABITANTS

The total number of different inhabitants of the type.

fn to_usize(&self) -> usize

Should return a number in the range 0..INHABITANTS.

fn from_usize(i: usize) -> Option<Self>

Should be the inverse function of to_usize.

impl<const A: usize, const B: usize> Hash for InRange<A, B>

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 A: usize, const B: usize> InRangeBounds for InRange<A, B>

const MIN: usize = A

The smallest value representable (if INHABITANTS is non-zero).

const INHABITANTS: usize

The number of values representable.

unsafe fn new_unchecked(i: usize) -> Self

Creates a value without checking whether the value is in range. This results in undefined behavior if the value is not in range.

fn get(self) -> usize

Returns the value as a usize.

fn new_from_start_offset(offset: usize) -> Option<Self>

Same as InRangeBounds::new(Self::MIN + i).

fn offset_from_start(i: usize) -> Option<usize>

Returns the offset from Self::MIN if i is in range.

fn in_bounds(i: usize) -> bool

Returns whether i is in range.

fn new(i: usize) -> Option<Self>

Creates a value if the given value is in range.

impl<const A: usize, const B: usize> Ord for InRange<A, B>

fn cmp(&self, other: &InRange<A, B>) -> 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 A: usize, const B: usize> PartialEq for InRange<A, B>

fn eq(&self, other: &InRange<A, B>) -> 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 A: usize, const B: usize> PartialOrd for InRange<A, B>

fn partial_cmp(&self, other: &InRange<A, B>) -> 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 A: usize, const B: usize> Copy for InRange<A, B>

impl<const A: usize, const B: usize> Eq for InRange<A, B>

impl<const A: usize, const B: usize> StructuralPartialEq for InRange<A, B>