Struct amplify_num::u5

pub struct u5(_);

5-bit unsigned integer in the range 0..32

Implementations

impl u5

pub const BITS: u32

Bit dimension

pub const MIN: Self

Minimum value

pub const MAX: Self

Maximal value

pub const ONE: Self

One value

pub const ZERO: Self

One value

pub fn with(value: u8) -> Self

Creates a new value from a provided `value.

Panics if the value exceeds Self::MAX

pub fn as_u8(self) -> u8

Returns inner u8 representation, which is always less or equal to Self::MAX

impl u5

pub fn checked_add<T>(self, rhs: T) -> Option<Self> where
    T: Into<u8>, 

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

pub fn saturating_add<T>(self, rhs: T) -> Self where
    T: Into<u8>, 

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

pub fn overflowing_add<T>(self, rhs: T) -> (Self, bool) where
    T: Into<u8>, 

Calculates self + rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn wrapping_add<T>(self, rhs: T) -> Self where
    T: Into<u8>, 

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

pub fn checked_sub<T>(self, rhs: T) -> Option<Self> where
    T: Into<u8>, 

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

pub fn saturating_sub<T>(self, rhs: T) -> Self where
    T: Into<u8>, 

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

pub fn overflowing_sub<T>(self, rhs: T) -> (Self, bool) where
    T: Into<u8>, 

Calculates self - rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn wrapping_sub<T>(self, rhs: T) -> Self where
    T: Into<u8>, 

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

pub fn checked_mul<T>(self, rhs: T) -> Option<Self> where
    T: Into<u8>, 

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

pub fn saturating_mul<T>(self, rhs: T) -> Self where
    T: Into<u8>, 

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

pub fn overflowing_mul<T>(self, rhs: T) -> (Self, bool) where
    T: Into<u8>, 

Calculates self * rhs

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn wrapping_mul<T>(self, rhs: T) -> Self where
    T: Into<u8>, 

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Trait Implementations

impl<T> Add<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for u5 where
    T: Into<u8>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl AsRef<u8> for u5

fn as_ref(&self) -> &u8

Performs the conversion.

impl<T> BitAnd<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T> BitAnd<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T> BitAndAssign<T> for u5 where
    T: Into<u8>, 

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T> BitOr<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T> BitOr<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T> BitOrAssign<T> for u5 where
    T: Into<u8>, 

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T> BitXor<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T> BitXor<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T> BitXorAssign<T> for u5 where
    T: Into<u8>, 

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

impl Clone for u5

fn clone(&self) -> u5

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for u5

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

Formats the value using the given formatter.

impl Default for u5

fn default() -> u5

Returns the “default value” for a type.

impl Display for u5

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

Formats the value using the given formatter.

impl<T> Div<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Div<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign<T> for u5 where
    T: Into<u8>, 

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl FromStr for u5

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 Hash for u5

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, 

Feeds a slice of this type into the given Hasher.

impl<T> Mul<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for u5 where
    T: Into<u8>, 

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Ord for u5

fn cmp(&self, other: &u5) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<u5> for u5

fn eq(&self, other: &u5) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &u5) -> bool

This method tests for !=.

impl PartialOrd<u5> for u5

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

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Rem<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T> Rem<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T> RemAssign<T> for u5 where
    T: Into<u8>, 

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T> Shl<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> Shl<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShlAssign<T> for u5 where
    T: Into<u8>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T> Shr<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> Shr<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> ShrAssign<T> for u5 where
    T: Into<u8>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> Sub<T> for u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<T> for &u5 where
    T: Into<u8>, 

type Output = u5

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for u5 where
    T: Into<u8>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<u8> for u5

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for u5

impl Eq for u5

impl StructuralEq for u5

impl StructuralPartialEq for u5