Struct NonValueU16 

pub struct NonValueU16<const V: u16>(/* private fields */);

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

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

Examples

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

See also NonExtremeU16.

Implementations

impl<const V: u16> NonValueU16<V>

pub const MAX: NonValueU16<V>

Returns the maximum possible value.

pub const MIN: NonValueU16<V>

Returns the minimum possible value.

pub const VALID_VALUES: u16 = 65_535u16

Returns the number of valid values.

pub const INVALID_VALUES: u16 = 1u16

Returns the number of invalid values.

pub const fn new(value: u16) -> Option<NonValueU16<V>>

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

pub const fn new_lossy(value: u16) -> NonValueU16<V>

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: u16) -> NonValueU16<V>

Returns a NonValueU16 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) -> u16

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: u16, ) -> Result<NonValueU16<V>, NicheValueError>

Checked integer addition. Computes self + rhs.

Errors

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

pub const fn checked_sub( &self, other: u16, ) -> Result<NonValueU16<V>, NicheValueError>

Checked integer substration. Computes self - rhs.

Errors

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

pub const fn strict_add(&self, other: u16) -> NonValueU16<V>

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: u16) -> NonValueU16<V>

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: u16) -> NonValueU16<V>

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: u16) -> NonValueU16<V>

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: u16) -> NonValueU16<V>

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: u16) -> NonValueU16<V>

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: u16> Binary for NonValueU16<V>

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

Formats the value using the given formatter.

impl<const V: u16> BitSized<{<$IP>::BYTE_SIZE * 8}> for NonValueU16<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: u16> Clone for NonValueU16<V>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const V: u16> Debug for NonValueU16<V>

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

Formats the value using the given formatter.

impl Default for NonValueU16<devela_base_core::::num::niche::mem::non_value::__impls_NonValueU16::NonExtremeU16::{constant#0}>

fn default() -> NonValueU16<devela_base_core::::num::niche::mem::non_value::__impls_NonValueU16::NonExtremeU16::{constant#0}>

Features

Makes use of the unsafe_niche feature if enabled.

impl<const V: u16> Display for NonValueU16<V>

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

Formats the value using the given formatter.

impl<const V: u16> From<NonValueU16<V>> for u16

fn from(value: NonValueU16<V>) -> u16

Converts to this type from the input type.

impl<const V: u16> FromStr for NonValueU16<V>

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<NonValueU16<V>, <NonValueU16<V> as FromStr>::Err>

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

impl<const V: u16> Hash for NonValueU16<V>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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: u16> LowerHex for NonValueU16<V>

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

Formats the value using the given formatter.

impl<const V: u16> Octal for NonValueU16<V>

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

Formats the value using the given formatter.

impl<const V: u16> Ord for NonValueU16<V>

fn cmp(&self, other: &NonValueU16<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: u16> PartialEq for NonValueU16<V>

fn eq(&self, other: &NonValueU16<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: u16> PartialOrd for NonValueU16<V>

fn partial_cmp(&self, other: &NonValueU16<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: u16> TryFrom<u16> for NonValueU16<V>

fn try_from( value: u16, ) -> Result<NonValueU16<V>, <NonValueU16<V> as TryFrom<u16>>::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: u16> UpperHex for NonValueU16<V>

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

Formats the value using the given formatter.

impl<const V: u16> Copy for NonValueU16<V>

impl<const V: u16> Eq for NonValueU16<V>

impl<const V: u16> StructuralPartialEq for NonValueU16<V>