Struct amplify_num::u1

source · [−]

pub struct u1(_);

Expand description

1-bit unsigned integer in the range 0..1. It can be used instead of bool when 1-bit numeric (and not boolean) arithmetic is required

Implementations

impl u1

pub const BITS: u32 = 1u32

Bit dimension

pub const MIN: Self = Self(0)

Minimum value

pub const MAX: Self = Self(2 - 1)

Maximal value

pub const ONE: Self = Self(1)

One value

pub const ZERO: Self = Self(0)

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 u1

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 u1 where
T: Into<u8>,

type Output = u1

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

type Output = u1

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

fn add_assign(&mut self, rhs: T)

Performs the += operation. Read more

impl AsRef<u8> for u1

fn as_ref(&self) -> &u8

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

impl Binary for u1

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

Formats the value using the given formatter.

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

type Output = u1

The resulting type after applying the & operator.

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

Performs the & operation. Read more

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

type Output = u1

The resulting type after applying the & operator.

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

Performs the & operation. Read more

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

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation. Read more

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

type Output = u1

The resulting type after applying the | operator.

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

Performs the | operation. Read more

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

type Output = u1

The resulting type after applying the | operator.

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

Performs the | operation. Read more

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

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation. Read more

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

type Output = u1

The resulting type after applying the ^ operator.

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

Performs the ^ operation. Read more

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

type Output = u1

The resulting type after applying the ^ operator.

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

Performs the ^ operation. Read more

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

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation. Read more

impl Clone for u1

fn clone(&self) -> u1

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 Debug for u1

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

Formats the value using the given formatter. Read more

impl Default for u1

fn default() -> u1

Returns the “default value” for a type. Read more

impl Display for u1

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

Formats the value using the given formatter. Read more

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

type Output = u1

The resulting type after applying the / operator.

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

Performs the / operation. Read more

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

type Output = u1

The resulting type after applying the / operator.

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

Performs the / operation. Read more

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

fn div_assign(&mut self, rhs: T)

Performs the /= operation. Read more

impl From<u1> for u8

fn from(val: u1) -> Self

Converts to this type from the input type.

impl FromStr for u1

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

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,

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

impl LowerHex for u1

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

Formats the value using the given formatter.

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

type Output = u1

The resulting type after applying the * operator.

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

Performs the * operation. Read more

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

type Output = u1

The resulting type after applying the * operator.

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

Performs the * operation. Read more

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

fn mul_assign(&mut self, rhs: T)

Performs the *= operation. Read more

impl Octal for u1

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

Formats the value using the given formatter.

impl Ord for u1

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl PartialEq<u1> for u1

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

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

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

This method tests for !=.

impl PartialOrd<u1> for u1

fn partial_cmp(&self, other: &u1) -> 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

This method 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

This method 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

This method 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

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

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

type Output = u1

The resulting type after applying the % operator.

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

Performs the % operation. Read more

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

type Output = u1

The resulting type after applying the % operator.

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

Performs the % operation. Read more

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

fn rem_assign(&mut self, rhs: T)

Performs the %= operation. Read more

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

type Output = u1

The resulting type after applying the << operator.

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

Performs the << operation. Read more

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

type Output = u1

The resulting type after applying the << operator.

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

Performs the << operation. Read more

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

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation. Read more

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

type Output = u1

The resulting type after applying the >> operator.

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

Performs the >> operation. Read more

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

type Output = u1

The resulting type after applying the >> operator.

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

Performs the >> operation. Read more

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

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation. Read more

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

type Output = u1

The resulting type after applying the - operator.

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

Performs the - operation. Read more

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

type Output = u1

The resulting type after applying the - operator.

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

Performs the - operation. Read more

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

fn sub_assign(&mut self, rhs: T)

Performs the -= operation. Read more

impl TryFrom<u8> for u1

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 UpperHex for u1

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

Formats the value using the given formatter.

impl Copy for u1

impl Eq for u1

impl StructuralEq for u1

impl StructuralPartialEq for u1

Auto Trait Implementations

impl RefUnwindSafe for u1

impl Send for u1

impl Sync for u1

impl Unpin for u1

impl UnwindSafe for u1

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> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.