Struct NonMax 

pub struct NonMax<T: NonMaxItem>(/* private fields */);

A wrapper type for an integer that cannot be its maximum value.

This type leverages Rust’s NonZero optimization by mapping the maximum value to zero internally. As a result, Option<NonMax<T>> has the same size as the underlying primitive type T.

Examples

assert_eq!(size_of::<NonMaxU32>(), 4);
assert_eq!(size_of::<Option<NonMaxU32>>(), 4);

Implementations

impl<T: NonMaxItem + Copy> NonMax<T>

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

Creates a new NonMax if the given value is not the maximum value.

Examples

assert!(NonMaxU8::new(254).is_some());
assert!(NonMaxU8::new(255).is_none());

pub fn get(&self) -> T

Returns the underlying primitive value.

Examples

let x = NonMaxU32::new(123).unwrap();
assert_eq!(x.get(), 123);

impl<T: NonMaxItem + Copy + PartialEq> NonMax<T>

pub fn is_min(&self) -> bool

Returns true if this is the minimum value.

pub fn is_max(&self) -> bool

Returns true if this is the maximum possible value for this type.

pub fn is_zero(&self) -> bool

Returns true if the value is zero.

impl<T: NonMaxItem + Copy> NonMax<T>

pub fn checked_add(self, rhs: Self) -> Option<Self>

Checked integer addition. Computes self + rhs, returning None if overflow occurred or if the result is the maximum value.

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred or if the result is the maximum value.

pub fn checked_mul(self, rhs: Self) -> Option<Self>

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred or if the result is the maximum value.

pub fn checked_div(self, rhs: Self) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if the divisor is zero or if the result is the maximum value.

pub fn checked_rem(self, rhs: Self) -> Option<Self>

Checked integer remainder. Computes self % rhs, returning None if the divisor is zero or if the result is the maximum value.

pub fn checked_add_val(self, rhs: T) -> Option<Self>

Checked addition with a primitive value.

Examples

let x = NonMaxU8::new(100).unwrap();
assert_eq!(x.checked_add_val(50).unwrap().get(), 150);
assert!(x.checked_add_val(155).is_none()); // 255 is MAX

pub fn checked_sub_val(self, rhs: T) -> Option<Self>

Checked subtraction with a primitive value.

pub fn checked_mul_val(self, rhs: T) -> Option<Self>

Checked multiplication with a primitive value.

pub fn checked_div_val(self, rhs: T) -> Option<Self>

Checked division with a primitive value.

pub fn checked_rem_val(self, rhs: T) -> Option<Self>

Checked remainder with a primitive value.

impl NonMax<u8>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: u8) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<u16>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: u16) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<u32>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: u32) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<u64>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

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

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<u128>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: u128) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<usize>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: usize) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<i8>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: i8) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<i16>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: i16) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<i32>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: i32) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<i64>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: i64) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<i128>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: i128) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

impl NonMax<isize>

pub const MIN: Self

The minimum value for this type.

pub const MAX: Self

The maximum value for this type.

pub const ZERO: Self

The zero value for this type.

pub const unsafe fn new_unchecked(value: isize) -> Self

Creates a new NonMax without checking the value.

Safety

The value must not be the maximum value of the underlying type.

Trait Implementations

impl<T: NonMaxItem + Copy + Add<Output = T>> Add<T> for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: NonMaxItem + Copy + Add<Output = T>> Add for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T: NonMaxItem + Copy + Add<Output = T>> AddAssign<T> for NonMax<T>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T: NonMaxItem + Copy + Add<Output = T>> AddAssign for NonMax<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: NonMaxItem + Copy + Binary> Binary for NonMax<T>

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

Formats the value using the given formatter.

impl<T: Clone + NonMaxItem> Clone for NonMax<T>

where T::NonZero: Clone,

fn clone(&self) -> NonMax<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + NonMaxItem> Debug for NonMax<T>

where T::NonZero: Debug,

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

Formats the value using the given formatter.

impl<T: NonMaxItem + Copy> Default for NonMax<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: NonMaxItem + Copy + Display> Display for NonMax<T>

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

Formats the value using the given formatter.

impl<T: NonMaxItem + Copy + Div<T, Output = T>> Div<T> for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: NonMaxItem + Copy + Div<Output = T>> Div for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<T: NonMaxItem + Copy + Div<T, Output = T>> DivAssign<T> for NonMax<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: NonMaxItem + Copy + Div<Output = T>> DivAssign for NonMax<T>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<NonMax<i128>> for i128

fn from(value: NonMax<i128>) -> Self

Converts to this type from the input type.

impl From<NonMax<i16>> for i16

fn from(value: NonMax<i16>) -> Self

Converts to this type from the input type.

impl From<NonMax<i32>> for i32

fn from(value: NonMax<i32>) -> Self

Converts to this type from the input type.

impl From<NonMax<i64>> for i64

fn from(value: NonMax<i64>) -> Self

Converts to this type from the input type.

impl From<NonMax<i8>> for i8

fn from(value: NonMax<i8>) -> Self

Converts to this type from the input type.

impl From<NonMax<isize>> for isize

fn from(value: NonMax<isize>) -> Self

Converts to this type from the input type.

impl From<NonMax<u128>> for u128

fn from(value: NonMax<u128>) -> Self

Converts to this type from the input type.

impl From<NonMax<u16>> for u16

fn from(value: NonMax<u16>) -> Self

Converts to this type from the input type.

impl From<NonMax<u32>> for u32

fn from(value: NonMax<u32>) -> Self

Converts to this type from the input type.

impl From<NonMax<u64>> for u64

fn from(value: NonMax<u64>) -> Self

Converts to this type from the input type.

impl From<NonMax<u8>> for u8

fn from(value: NonMax<u8>) -> Self

Converts to this type from the input type.

impl From<NonMax<usize>> for usize

fn from(value: NonMax<usize>) -> Self

Converts to this type from the input type.

impl<T: Hash + NonMaxItem> Hash for NonMax<T>

where T::NonZero: Hash,

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<T: NonMaxItem + Copy + LowerHex> LowerHex for NonMax<T>

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

Formats the value using the given formatter.

impl<T: NonMaxItem + Copy + Mul<Output = T>> Mul<T> for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: NonMaxItem + Copy + Mul<Output = T>> Mul for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T: NonMaxItem + Copy + Mul<Output = T>> MulAssign<T> for NonMax<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: NonMaxItem + Copy + Mul<Output = T>> MulAssign for NonMax<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: NonMaxItem + Copy + Octal> Octal for NonMax<T>

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

Formats the value using the given formatter.

impl<T: NonMaxItem + Copy + Ord> Ord for NonMax<T>

fn cmp(&self, other: &Self) -> 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<T: PartialEq + NonMaxItem> PartialEq for NonMax<T>

where T::NonZero: PartialEq,

fn eq(&self, other: &NonMax<T>) -> 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<T: NonMaxItem + Copy + PartialOrd> PartialOrd for NonMax<T>

fn partial_cmp(&self, other: &Self) -> 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<T: NonMaxItem + Copy + Rem<T, Output = T>> Rem<T> for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T: NonMaxItem + Copy + Rem<Output = T>> Rem for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<T: NonMaxItem + Copy + Rem<T, Output = T>> RemAssign<T> for NonMax<T>

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T: NonMaxItem + Copy + Rem<Output = T>> RemAssign for NonMax<T>

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<T: NonMaxItem + Copy + Sub<Output = T>> Sub<T> for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: NonMaxItem + Copy + Sub<Output = T>> Sub for NonMax<T>

type Output = NonMax<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<T: NonMaxItem + Copy + Sub<Output = T>> SubAssign<T> for NonMax<T>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T: NonMaxItem + Copy + Sub<Output = T>> SubAssign for NonMax<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<i128> for NonMax<i128>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for NonMax<i16>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for NonMax<i32>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for NonMax<i64>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for NonMax<i8>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for NonMax<isize>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u128> for NonMax<u128>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for NonMax<u16>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for NonMax<u32>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for NonMax<u64>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for NonMax<u8>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for NonMax<usize>

type Error = MaxValueError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: NonMaxItem + Copy + UpperHex> UpperHex for NonMax<T>

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

Formats the value using the given formatter.

impl<T: Copy + NonMaxItem> Copy for NonMax<T>

where T::NonZero: Copy,

impl<T: Eq + NonMaxItem> Eq for NonMax<T>

where T::NonZero: Eq,

impl<T: NonMaxItem> StructuralPartialEq for NonMax<T>