Struct NonValueU16 Copy item path

impl<const V: u16> NonValueU16<V>

pub const MAX: Self

Returns the maximum possible value.

pub const MIN: Self

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<Self> ⓘ

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

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

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

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

Formats the value using the given formatter. Read more

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). Read more

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type. Read more

fn bit_size(&self) -> usize ⓘ

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

fn min_byte_size(&self) -> usize ⓘ

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

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

type Bits = u16

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

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

Returns a copy 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: u16> Debug for NonValueU16<V>

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

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<Self, Self::Err> ⓘ

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

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

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

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

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

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

fn cmp(&self, other: &NonValueU16<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: 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 ==.

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

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

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

Formats the value using the given formatter. Read more

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

Auto Trait Implementations§

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

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

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

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

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

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize ⓘ

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize ⓘ

Returns the size of this type in bytes. Read more

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.

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

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

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

Performs copy-assignment from self to dst. 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<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

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

Returns the type name of self. Read more

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

Returns true if Self is of type T. Read more

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

Upcasts &self as &dyn Any. Read more

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

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

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

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

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

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

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

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

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

const NEEDS_DROP: bool = _

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

fn mem_align_of<T>() -> usize ⓘ

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

fn mem_align_of_val(&self) -> usize ⓘ

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

fn mem_size_of<T>() -> usize ⓘ

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize ⓘ

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

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

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

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

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

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

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

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

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

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

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

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

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

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

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

impl<T> From<T> for T

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

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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