Struct u3 

pub struct u3(/* private fields */);

3-bit unsigned integer in the range 0..8

Implementations

impl u3

pub const BITS: u32 = 3u32

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 const fn with(value: u8) -> Self

Creates a new value from a provided `value.

Panics if the value exceeds Self::MAX

pub const fn to_u8(&self) -> u8

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

pub const fn into_u8(self) -> u8

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

impl u3

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.

pub fn div_rem(self, other: Self) -> Result<(Self, Self), DivError>

Trait Implementations

impl<T> Add<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for u3

where T: Into<u8>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl AsRef<u8> for u3

fn as_ref(&self) -> &u8

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for u3

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

Formats the value using the given formatter.

impl<T> BitAnd<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T> BitAnd<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T> BitAndAssign<T> for u3

where T: Into<u8>,

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T> BitOr<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T> BitOr<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T> BitOrAssign<T> for u3

where T: Into<u8>,

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T> BitXor<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T> BitXor<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T> BitXorAssign<T> for u3

where T: Into<u8>,

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

impl Clone for u3

fn clone(&self) -> u3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for u3

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

Formats the value using the given formatter.

impl Default for u3

fn default() -> u3

Returns the “default value” for a type.

impl Display for u3

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

Formats the value using the given formatter.

impl<T> Div<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Div<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign<T> for u3

where T: Into<u8>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<u1> for u3

fn from(value: u1) -> Self

Converts to this type from the input type.

impl From<u2> for u3

fn from(value: u2) -> Self

Converts to this type from the input type.

impl From<u3> for u4

fn from(value: u3) -> Self

Converts to this type from the input type.

impl From<u3> for u5

fn from(value: u3) -> Self

Converts to this type from the input type.

impl From<u3> for u6

fn from(value: u3) -> Self

Converts to this type from the input type.

impl From<u3> for u7

fn from(value: u3) -> Self

Converts to this type from the input type.

impl From<u3> for u8

fn from(val: u3) -> Self

Converts to this type from the input type.

impl FromStr for u3

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 u3

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 LowerHex for u3

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

Formats the value using the given formatter.

impl<T> Mul<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for u3

where T: Into<u8>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Octal for u3

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

Formats the value using the given formatter.

impl Ord for u3

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

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

fn partial_cmp(&self, other: &u3) -> 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<T> Rem<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T> Rem<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T> RemAssign<T> for u3

where T: Into<u8>,

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T> Shl<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> Shl<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShlAssign<T> for u3

where T: Into<u8>,

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T> Shr<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> Shr<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> ShrAssign<T> for u3

where T: Into<u8>,

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> Sub<T> for &u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<T> for u3

where T: Into<u8>,

type Output = u3

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for u3

where T: Into<u8>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<u8> for u3

type Error = OverflowError<u8>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperHex for u3

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

Formats the value using the given formatter.

impl Copy for u3

impl Eq for u3

impl StructuralPartialEq for u3

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte