Struct fixed_bigint::fixeduint::FixedUInt

pub struct FixedUInt<T, const N: usize> where
    T: MachineWord,  { /* fields omitted */ }

Fixed-size unsigned integer, represented by array of N words of builtin unsigned type T

Implementations

impl<T: MachineWord, const N: usize> FixedUInt<T, N>

pub fn new() -> FixedUInt<T, N>

Creates and zero-initializes a FixedUInt.

pub fn bit_length(&self) -> u32

Returns number of used bits.

pub fn div_rem(&self, divisor: &Self) -> (Self, Self)

Performs a division, returning both the quotient and reminder in a tuple.

pub fn from_le_bytes(bytes: &[u8]) -> Self

Create a little-endian integer value from its representation as a byte array in little endian.

pub fn to_hex_str<'a>(&self, result: &'a mut [u8]) -> Result<&'a str, Error>

Converts to hex string, given a buffer.

Trait Implementations

impl<T: MachineWord, const N: usize> Add<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: MachineWord, const N: usize> BitAnd<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl<T: MachineWord, const N: usize> BitOr<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl<T: MachineWord, const N: usize> BitXor<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self::Output

Performs the ^ operation.

impl<T: MachineWord, const N: usize> Bounded for FixedUInt<T, N>

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent

impl<T: MachineWord, const N: usize> CheckedAdd for FixedUInt<T, N>

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

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

impl<T: MachineWord, const N: usize> CheckedDiv for FixedUInt<T, N>

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

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

impl<T: MachineWord, const N: usize> CheckedMul for FixedUInt<T, N>

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

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

impl<T: MachineWord, const N: usize> CheckedSub for FixedUInt<T, N>

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

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

impl<T: Clone, const N: usize> Clone for FixedUInt<T, N> where
    T: MachineWord, 

fn clone(&self) -> FixedUInt<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, const N: usize> Copy for FixedUInt<T, N> where
    T: MachineWord, 

impl<T: Debug, const N: usize> Debug for FixedUInt<T, N> where
    T: MachineWord, 

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

Formats the value using the given formatter.

impl<T: MachineWord, const N: usize> Default for FixedUInt<T, N>

fn default() -> Self

Returns the “default value” for a type.

impl<T: MachineWord, const N: usize> Div<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl<T: Eq, const N: usize> Eq for FixedUInt<T, N> where
    T: MachineWord, 

impl<T: MachineWord, const N: usize> From<u16> for FixedUInt<T, N>

fn from(x: u16) -> Self

Performs the conversion.

impl<T: MachineWord, const N: usize> From<u32> for FixedUInt<T, N>

fn from(x: u32) -> Self

Performs the conversion.

impl<T: MachineWord, const N: usize> From<u64> for FixedUInt<T, N>

fn from(x: u64) -> Self

Performs the conversion.

impl<T: MachineWord, const N: usize> From<u8> for FixedUInt<T, N>

fn from(x: u8) -> Self

Performs the conversion.

impl<T: MachineWord, const N: usize> FromPrimitive for FixedUInt<T, N>

fn from_i64(_: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(input: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<T: MachineWord, const N: usize> LowerHex for FixedUInt<T, N> where
    u8: TryFrom<T>, 

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

Formats the value using the given formatter.

impl<T: MachineWord, const N: usize> Mul<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<T: MachineWord, const N: usize> Not for FixedUInt<T, N>

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: MachineWord, const N: usize> Num for FixedUInt<T, N>

type FromStrRadixErr = ParseIntError

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

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

impl<T: MachineWord, const N: usize> NumCast for FixedUInt<T, N>

fn from<X>(_: X) -> Option<Self> where
    T: ToPrimitive, 

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<T: MachineWord, const N: usize> One for FixedUInt<T, N>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

pub fn set_one(&mut self)

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

pub fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T: MachineWord, const N: usize> Ord for FixedUInt<T, N>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: MachineWord, const N: usize> OverflowingAdd for FixedUInt<T, N>

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

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

impl<T: MachineWord, const N: usize> OverflowingSub for FixedUInt<T, N>

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

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

impl<T: PartialEq, const N: usize> PartialEq<FixedUInt<T, N>> for FixedUInt<T, N> where
    T: MachineWord, 

fn eq(&self, other: &FixedUInt<T, N>) -> bool

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

fn ne(&self, other: &FixedUInt<T, N>) -> bool

This method tests for !=.

impl<T: MachineWord, const N: usize> PartialOrd<FixedUInt<T, N>> for FixedUInt<T, N>

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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: MachineWord, const N: usize> PrimInt for FixedUInt<T, N>

fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

fn rotate_left(self, _: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

fn rotate_right(self, _: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

fn signed_shl(self, _: u32) -> Self

Shifts the bits to the left by a specified amount, n, filling zeros in the least significant bits.

fn signed_shr(self, _: u32) -> Self

Shifts the bits to the right by a specified amount, n, copying the “sign bit” in the most significant bits even for unsigned types.

fn unsigned_shl(self, _: u32) -> Self

Shifts the bits to the left by a specified amount, n, filling zeros in the least significant bits.

fn unsigned_shr(self, _: u32) -> Self

Shifts the bits to the right by a specified amount, n, filling zeros in the most significant bits.

fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

fn from_be(_: Self) -> Self

Convert an integer from big endian to the target’s endianness.

fn from_le(_: Self) -> Self

Convert an integer from little endian to the target’s endianness.

fn to_be(self) -> Self

Convert self to big endian from the target’s endianness.

fn to_le(self) -> Self

Convert self to little endian from the target’s endianness.

fn pow(self, _: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

impl<T: MachineWord, const N: usize> Rem<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: MachineWord, const N: usize> Saturating for FixedUInt<T, N>

Note: This is marked deprecated, but still used by PrimInt

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

Saturating addition operator. Returns a+b, saturating at the numeric bounds instead of overflowing.

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

Saturating subtraction operator. Returns a-b, saturating at the numeric bounds instead of overflowing.

impl<T: MachineWord, const N: usize> SaturatingAdd for FixedUInt<T, N>

fn saturating_add(&self, other: &Self) -> Self

Saturating addition operator. Returns a+b, saturating at the numeric bounds instead of overflowing.

impl<T: MachineWord, const N: usize> SaturatingSub for FixedUInt<T, N>

fn saturating_sub(&self, other: &Self) -> Self

Saturating subtraction operator. Returns a-b, saturating at the numeric bounds instead of overflowing.

impl<T: MachineWord, const N: usize> Shl<usize> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the << operator.

fn shl(self, bits: usize) -> Self::Output

Performs the << operation.

impl<T: MachineWord, const N: usize> Shr<usize> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, bits: usize) -> Self::Output

Performs the >> operation.

impl<T, const N: usize> StructuralEq for FixedUInt<T, N> where
    T: MachineWord, 

impl<T, const N: usize> StructuralPartialEq for FixedUInt<T, N> where
    T: MachineWord, 

impl<T: MachineWord, const N: usize> Sub<FixedUInt<T, N>> for FixedUInt<T, N>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<T: MachineWord, const N: usize> ToPrimitive for FixedUInt<T, N>

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

pub fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

pub fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

pub fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

pub fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

pub fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

pub fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

pub fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

pub fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

pub fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

pub fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

pub fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

pub fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl<T: MachineWord, const N: usize> UpperHex for FixedUInt<T, N> where
    u8: TryFrom<T>, 

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

Formats the value using the given formatter.

impl<T: MachineWord, const N: usize> WrappingAdd for FixedUInt<T, N>

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

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

impl<T: MachineWord, const N: usize> WrappingSub for FixedUInt<T, N>

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

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

impl<T: MachineWord, const N: usize> Zero for FixedUInt<T, N>

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.

pub fn set_zero(&mut self)

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