Struct nonminmax::NonMaxU64

#[repr(transparent)]
pub struct NonMaxU64 { /* fields omitted */ }

An integer of type u64 which is known to not equal u64::MAX.

This type allows for niche filling optimization (similar to the existing std::num::NonZero* types) meaning items such as Option<NonMaxU64> and Result<NonMaxU64, ()> take up the same amount of space as u64.

// Create using `new`, extract value using `get`
let x = NonMaxU64::new(123).unwrap();
assert_eq!(x.get(), 123);

// The value cannot be `u64::MAX`
let y = NonMaxU64::new(u64::MAX);
assert_eq!(y, None);

// Niche filling optimization works!
use std::mem::size_of;
assert_eq!(size_of::<u64>(), size_of::<NonMaxU64>());
assert_eq!(size_of::<u64>(), size_of::<Option<NonMaxU64>>());

Methods

impl NonMaxU64

pub fn new(value: u64) -> Option<Self>

Creates an instance of NonMaxU64 by checking if the value is not u64::MAX.

pub unsafe fn new_unchecked(value: u64) -> Self

Creates an instance of NonMaxU64 without checking if the value is not u64::MAX.

Safety

The value cannot be equal to u64::MAX.

pub fn get(self) -> u64

Returns the integer value.

Trait Implementations

impl Clone for NonMaxU64

fn clone(&self) -> NonMaxU64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for NonMaxU64

impl Debug for NonMaxU64

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

Formats the value using the given formatter.

impl Display for NonMaxU64

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

Formats the value using the given formatter.

impl Eq for NonMaxU64

impl From<NonMaxU64> for u64

fn from(nontype: NonMaxU64) -> Self

Performs the conversion.

impl Hash for NonMaxU64

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

fn cmp(&self, other: &NonMaxU64) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<NonMaxU64> for NonMaxU64

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

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

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

This method tests for !=.

impl PartialOrd<NonMaxU64> for NonMaxU64

fn partial_cmp(&self, other: &NonMaxU64) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for NonMaxU64

impl StructuralPartialEq for NonMaxU64