NonValueU64

Struct NonValueU64 

pub struct NonValueU64<const V: u64>(/* private fields */);
Expand description

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

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

§Examples

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

See also NonExtremeU64.

Implementations§

§

impl<const V: u64> NonValueU64<V>

pub const MAX: NonValueU64<V>

Returns the maximum possible value.

pub const MIN: NonValueU64<V>

Returns the minimum possible value.

pub const VALID_VALUES: u64 = 18_446_744_073_709_551_615u64

Returns the number of valid values.

pub const INVALID_VALUES: u64 = 1u64

Returns the number of invalid values.

pub const fn new(value: u64) -> Option<NonValueU64<V>>

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

pub const fn new_lossy(value: u64) -> NonValueU64<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: u64) -> NonValueU64<V>

Returns a NonValueU64 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) -> u64

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: u64, ) -> Result<NonValueU64<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: u64, ) -> Result<NonValueU64<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: u64) -> NonValueU64<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: u64) -> NonValueU64<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: u64) -> NonValueU64<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: u64) -> NonValueU64<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: u64) -> NonValueU64<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: u64) -> NonValueU64<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: u64> Binary for NonValueU64<V>

§

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

Formats the value using the given formatter. Read more
Source§

impl<const V: u64> BitSized<{<$IP>::BYTE_SIZE * 8}> for NonValueU64<V>

Source§

const BIT_SIZE: usize = _

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

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type. Read more
Source§

fn bit_size(&self) -> usize

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

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type. Read more
§

impl<const V: u64> Clone for NonValueU64<V>

§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<const V: u64> Debug for NonValueU64<V>

§

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

Formats the value using the given formatter. Read more
§

impl Default for NonValueU64<devela_base_core::::num::niche::mem::non_value::__impls_NonValueU64::NonExtremeU64::{constant#0}>

§

fn default() -> NonValueU64<devela_base_core::::num::niche::mem::non_value::__impls_NonValueU64::NonExtremeU64::{constant#0}>

§Features

Makes use of the unsafe_niche feature if enabled.

§

impl<const V: u64> Display for NonValueU64<V>

§

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

Formats the value using the given formatter. Read more
§

impl<const V: u64> From<NonValueU64<V>> for u64

§

fn from(value: NonValueU64<V>) -> u64

Converts to this type from the input type.
§

impl<const V: u64> FromStr for NonValueU64<V>

§

type Err = ParseIntError

The associated error which can be returned from parsing.
§

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

Parses a string s to return a value of this type. Read more
§

impl<const V: u64> Hash for NonValueU64<V>

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl<const V: u64> LowerHex for NonValueU64<V>

§

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

Formats the value using the given formatter. Read more
§

impl<const V: u64> Octal for NonValueU64<V>

§

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

Formats the value using the given formatter. Read more
§

impl<const V: u64> Ord for NonValueU64<V>

§

fn cmp(&self, other: &NonValueU64<V>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
§

impl<const V: u64> PartialEq for NonValueU64<V>

§

fn eq(&self, other: &NonValueU64<V>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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: u64> PartialOrd for NonValueU64<V>

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl<const V: u64> TryFrom<u64> for NonValueU64<V>

§

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

§

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

Formats the value using the given formatter. Read more
§

impl<const V: u64> Copy for NonValueU64<V>

§

impl<const V: u64> Eq for NonValueU64<V>

§

impl<const V: u64> StructuralPartialEq for NonValueU64<V>

Auto Trait Implementations§

§

impl<const V: u64> Freeze for NonValueU64<V>

§

impl<const V: u64> RefUnwindSafe for NonValueU64<V>

§

impl<const V: u64> UnwindSafe for NonValueU64<V>

§

impl<const V: u64> Send for NonValueU64<V>

§

impl<const V: u64> Sync for NonValueU64<V>

§

impl<const V: u64> Unpin for NonValueU64<V>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
§

impl<T, R> Chain<R> for T
where T: ?Sized,

§

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.
§

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.
§

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> ExtAny for T
where T: Any + ?Sized,

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Source§

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T>

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T>

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Source§

impl<T> ExtMem for T
where T: ?Sized,

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Hook for T

§

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more
§

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Ungil for T
where T: Send,