Struct NonMaxUsize 

pub struct NonMaxUsize(/* private fields */);

A usize value that is known not to be usize::MAX.

This enables some memory layout optimizations. For example, Option<usize> is the same size as usize:

assert_eq!(
    core::mem::size_of::<u32>(),
    core::mem::size_of::<Option<NonMaxU32>>(),
);

Implementations

impl NonMaxUsize

pub fn new(x: usize) -> Option<Self>

Construct a new usize value.

Returns None when given usize::MAX.

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

Unsafely construct a new usize value.

Safety

The given value must not be usize::MAX.

pub fn get(&self) -> usize

Get the underlying usize value.

Trait Implementations

impl Clone for NonMaxUsize

fn clone(&self) -> NonMaxUsize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NonMaxUsize

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

Formats the value using the given formatter.

impl Default for NonMaxUsize

fn default() -> Self

Returns the “default value” for a type.

impl Hash for NonMaxUsize

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 Ord for NonMaxUsize

fn cmp(&self, other: &NonMaxUsize) -> 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 PartialEq for NonMaxUsize

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

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

impl Eq for NonMaxUsize

impl StructuralPartialEq for NonMaxUsize