Struct bitint::U40

#[repr(transparent)]
pub struct U40(_);

The 40-bit unsigned bitint type.

Layout

This type is #[repr(transparent)] to u64, but imposes additional invariants.

Invariants

The value is represented in the least significant bits of a u64. The unused most significant bits are always clear.

Implementations

impl U40

pub const BITS: u32 = 40u32

The bit width of this type.

See also: UBitint::BITS

pub const MASK: u64 = 1_099_511_627_775u64

The bit mask for the bits that may be set in values of this type.

See also: UBitint::MASK

pub const MIN: Self = _

The smallest value of this type.

See also: UBitint::MIN

pub const MAX: Self = _

The largest value of this type.

See also: UBitint::MAX

pub const ZERO: Self = _

The value 0 represented in this type.

See also: UBitint::ZERO, num_traits::Zero

pub const ONE: Self = _

The value 1 represented in this type.

See also: UBitint::ONE, num_traits::One

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

Creates a bitint from a primitive value if it is in range for this type, as determined by is_in_range.

This method is a const variant of UBitint::new.

pub const fn new_masked(value: u64) -> Self

Creates a bitint by masking off the upper bits of a primitive value.

This conversion is lossless if the value is in range for this type, as determined by is_in_range.

This method is a const variant of UBitint::new_masked.

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

Creates a bitint from a primitive value without checking whether it is in range for this type.

Safety

The value must be in range for this type, as determined by is_in_range.

This method is a const variant of UBitint::new_unchecked.

pub const fn to_primitive(self) -> u64

Converts the value to a primitive type.

The result is in range for this type, as determined by is_in_range.

pub const fn is_in_range(value: u64) -> bool

Checks whether a primitive value is in range for this type.

There are a few equivalent ways to express this check.

• The unused most significant bits are clear: (value & !Self::MASK) == 0
• The value is between MIN and MAX, inclusive: value >= Self::MIN.as_primitive() && value <= Self::MAX.as_primitive()

This method is a const variant of UBitint::is_in_range.

pub const fn checked_add(self, rhs: Self) -> Option<Self>

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

pub const unsafe fn unchecked_add(self, rhs: Self) -> Self

Available on unchecked_math only.

Unchecked integer addition. Computes self + rhs, assuming overflow cannot occur.

Safety

The result must be in range for this type, as determined by is_in_range.

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

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

pub const unsafe fn unchecked_sub(self, rhs: Self) -> Self

Available on unchecked_math only.

Unchecked integer subtraction. Computes self - rhs, assuming overflow cannot occur.

Safety

The result must be in range for this type, as determined by is_in_range.

pub const fn checked_mul(self, rhs: Self) -> Option<Self>

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

pub const unsafe fn unchecked_mul(self, rhs: Self) -> Self

Available on unchecked_math only.

Unchecked integer multiplication. Computes self * rhs, assuming overflow cannot occur.

Safety

The result must be in range for this type, as determined by is_in_range.

pub const fn checked_div(self, rhs: Self) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if rhs == 0.

pub const fn checked_rem(self, rhs: Self) -> Option<Self>

Checked integer remainder. Computes self % rhs, returning None if rhs == 0.

pub const fn wrapping_add(self, rhs: Self) -> Self

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

pub const fn wrapping_sub(self, rhs: Self) -> Self

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

pub const fn wrapping_mul(self, rhs: Self) -> Self

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

Trait Implementations

impl Add<U40> for U40

type Output = U40

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<U40> for U40

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd<U40> for U40

type Output = U40

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<U40> for U40

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<U40> for U40

type Output = U40

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<U40> for U40

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<U40> for U40

type Output = U40

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<U40> for U40

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl CheckedAdd for U40

fn checked_add(&self, v: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedDiv for U40

fn checked_div(&self, v: &Self) -> Option<Self>

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedMul for U40

fn checked_mul(&self, v: &Self) -> Option<Self>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl CheckedRem for U40

fn checked_rem(&self, v: &Self) -> Option<Self>

Finds the remainder of dividing two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedSub for U40

fn checked_sub(&self, v: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for U40

fn clone(&self) -> U40

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for U40

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

Formats the value using the given formatter.

impl Display for U40

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

Formats the value using the given formatter.

impl Div<U40> for U40

type Output = U40

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<U40> for U40

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<U40> for u64

fn from(value: U40) -> Self

Converts to this type from the input type.

impl FromStr for U40

type Err = ParseBitintError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, ParseBitintError>

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

impl Hash for U40

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 Mul<U40> for U40

type Output = U40

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<U40> for U40

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for U40

type Output = U40

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Num for U40

type FromStrRadixErr = ParseBitintError

fn from_str_radix(str: &str, radix: u32) -> Result<Self, ParseBitintError>

Convert from a string and radix (typically 2..=36).

impl One for U40

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl Ord for U40

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<U40> for U40

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<U40> for U40

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

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

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

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

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

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

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

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

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

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

impl Rem<U40> for U40

type Output = U40

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<U40> for U40

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub<U40> for U40

type Output = U40

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<U40> for U40

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<u64> for U40

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, RangeError>

Performs the conversion.

impl UBitint for U40

type Primitive = u64

The primitive type that this type wraps.

const BITS: u32 = 40u32

The bit width of this type.

const MASK: u64 = 1_099_511_627_775u64

The bit mask for the bits that may be set in values of this type.

const MIN: Self = Self::MIN

The smallest value of this type.

const MAX: Self = Self::MAX

The largest value of this type.

const ZERO: Self = Self::ZERO

The value 0 represented in this type.

const ONE: Self = Self::ONE

The value 1 represented in this type.

fn new(value: u64) -> Option<Self>

Creates an unsigned bitint value from a primitive value if it is in range for this type, as determined by is_in_range.

fn new_masked(value: u64) -> Self

Creates an unsigned bitint value by masking off the upper bits of a primitive value.

unsafe fn new_unchecked(value: u64) -> Self

Creates an unsigned bitint value from a primitive value without checking whether it is in range for this type.

fn is_in_range(value: u64) -> bool

Checks whether a primitive value is in range for this type.

impl WrappingAdd for U40

fn wrapping_add(&self, v: &Self) -> Self

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

impl WrappingMul for U40

fn wrapping_mul(&self, v: &Self) -> Self

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

impl WrappingSub for U40

fn wrapping_sub(&self, v: &Self) -> Self

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

impl Zero for U40

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for U40

impl Eq for U40