Struct NonValueU128

pub struct NonValueU128<const V: u128>(/* private fields */);

𝟙 ⚗️ An unsigned integer that is known not to equal some specific value.

It has the same memory layout optimization as NonZeroU128, so that Option<NonValueU128> is the same size as NonValueU128.

Examples

assert![NonValueI8::<13>::new(13).is_none()];
assert![NonValueI8::<13>::new(12).unwrap().get() == 12];

See also NonExtremeU128.

Implementations

impl<const V: u128> NonValueU128<V>

pub const MAX: Self

Returns the maximum possible value.

pub const MIN: Self

Returns the minimum possible value.

pub const VALID_VALUES: u128 = 340_282_366_920_938_463_463_374_607_431_768_211_455u128

Returns the number of valid values.

pub const INVALID_VALUES: u128 = 1u128

Returns the number of invalid values.

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

Returns a NonValueU128 with the given value, if it is not equal to V.

pub const fn new_lossy(value: u128) -> Self

Creates a non-value integer, automatically converting the prohibited value V to the closest valid number (V-1 for most cases, V+1 for MIN).

Guarantees

• For unsigned MAX: V-1 → stored as !(V-1)
• For signed MIN: V+1 → stored as (V+1) ^ MIN
• All others: V-1 → stored as (V-1) ^ V

Features

• Can use the unsafe_niche feature internally.

Example

let x = assert_eq![NonValueU8::<255>::new_lossy(255).get(), 254];
let y = assert_eq![NonValueI8::<-128>::new_lossy(-128).get(), -127];

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

Returns a NonValueU128 if the given value if it is not equal to V.

Panics

Panics in debug if the given value is equal to V.

Safety

The given value must never be equal to V.

pub const fn get(&self) -> u128

Returns the value as a primitive type.

pub const fn is_max(&self) -> bool

Returns true if it is equal to the maximum value (MAX).

pub const fn is_min(&self) -> bool

Returns true if it is equal to the minimum value (MIN).

pub const fn checked_add(&self, other: u128) -> NumResult<Self>

Checked integer addition. Computes self + rhs.

Errors

Returns Overflow if the operations overflows, or Invalid if the result equals the forbidden value V.

pub const fn checked_sub(&self, other: u128) -> NumResult<Self>

Checked integer substration. Computes self - rhs.

Errors

Returns Overflow if the operations overflows, or Invalid if the result equals the forbidden value V.

pub const fn strict_add(&self, other: u128) -> Self

Strict integer addition. Computes self + rhs.

Panics

Panics on overflow or if the result equals the forbidden value V.

pub const fn strict_sub(&self, other: u128) -> Self

Strict integer substration. Computes self - rhs.

Panics

Panics on overflow or if the result equals the forbidden value V.

pub const fn saturating_add(&self, other: u128) -> Self

Saturating integer addition. Computes self + rhs.

Saturates at the numeric bounds instead of overflowing. If the result would equal V it will return V - 1.

pub const fn saturating_sub(&self, other: u128) -> Self

Saturating integer substration. Computes self - rhs.

Saturates at the numeric bounds instead of overflowing. If the result would equal V it will return V + 1.

pub const fn wrapping_add(&self, other: u128) -> Self

Wraping integer addition. Computes self + rhs.

Wraps at the numeric bounds instead of overflowing. If the result would equal V it will return V + 1.

pub const fn wrapping_sub(&self, other: u128) -> Self

Wraping integer subtraction. Computes self - rhs.

Wraps at the numeric bounds instead of overflowing. If the result would equal V it will return V - 1.

Trait Implementations

impl<const V: u128> Binary for NonValueU128<V>

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

Formats the value using the given formatter.

impl<const V: u128> BitSized<{$IP::BYTE_SIZE * 8}> for NonValueU128<V>

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding).

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type.

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding).

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type.

impl<const V: u128> CheckedBitPattern for NonValueU128<V>

type Bits = u128

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

fn is_valid_bit_pattern(bits: &Self::Bits) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

impl<const V: u128> Clone for NonValueU128<V>

fn clone(&self) -> NonValueU128<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const V: u128> Debug for NonValueU128<V>

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

Formats the value using the given formatter.

impl<const V: u128> Display for NonValueU128<V>

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

Formats the value using the given formatter.

impl<const V: u128> From<NonValueU128<V>> for u128

fn from(value: NonValueU128<V>) -> u128

Converts to this type from the input type.

impl<const V: u128> FromStr for NonValueU128<V>

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const V: u128> Hash for NonValueU128<V>

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 V: u128> LowerHex for NonValueU128<V>

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

Formats the value using the given formatter.

impl<const V: u128> Octal for NonValueU128<V>

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

Formats the value using the given formatter.

impl<const V: u128> Ord for NonValueU128<V>

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

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

fn partial_cmp(&self, other: &NonValueU128<V>) -> 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 V: u128> TryFrom<u128> for NonValueU128<V>

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

Features

Makes use of the unsafe_niche feature if enabled.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl<const V: u128> UpperHex for NonValueU128<V>

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

Formats the value using the given formatter.

impl<const V: u128> Copy for NonValueU128<V>

impl<const V: u128> Eq for NonValueU128<V>

impl<const V: u128> NoUninit for NonValueU128<V>

impl<const V: u128> PodInOption for NonValueU128<V>

impl<const V: u128> StructuralPartialEq for NonValueU128<V>

impl<const V: u128> ZeroableInOption for NonValueU128<V>