Struct fixed_width_field::MaxFieldUint

pub struct MaxFieldUint(pub [u64; 16]);

Little-endian large integer type

Tuple Fields

0: [u64; 16]

Implementations

impl MaxFieldUint

pub const MAX: MaxFieldUint

Maximum value.

pub const fn from_limbs(limbs: [u64; 16]) -> MaxFieldUint

pub fn low_u32(&self) -> u32

Conversion to u32

pub fn low_u64(&self) -> u64

Low word (u64)

pub fn as_u32(&self) -> u32

Conversion to u32 with overflow checking

Panics

Panics if the number is larger than 2^32.

pub fn as_u64(&self) -> u64

Conversion to u64 with overflow checking

Panics

Panics if the number is larger than u64::max_value().

pub fn as_usize(&self) -> usize

Conversion to usize with overflow checking

Panics

Panics if the number is larger than usize::max_value().

pub fn is_zero(&self) -> bool

Whether this is zero.

pub fn bits(&self) -> usize

Return the least number of bits needed to represent the number

pub fn bit(&self, index: usize) -> bool

Return if specific bit is set.

Panics

Panics if index exceeds the bit width of the number.

pub fn leading_zeros(&self) -> u32

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

pub fn trailing_zeros(&self) -> u32

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

pub fn byte(&self, index: usize) -> u8

Return specific byte.

Panics

Panics if index exceeds the byte width of the number.

pub fn to_big_endian(&self, bytes: &mut [u8])

Write to the slice in big-endian format.

pub fn to_little_endian(&self, bytes: &mut [u8])

Write to the slice in little-endian format.

pub fn exp10(n: usize) -> Self

Create 10**n as this type.

Panics

Panics if the result overflows the type.

pub fn zero() -> Self

Zero (additive identity) of this type.

pub fn one() -> Self

One (multiplicative identity) of this type.

pub fn max_value() -> Self

The maximum value which can be inhabited by this type.

pub fn div_mod(self, other: Self) -> (Self, Self)

Returns a pair (self / other, self % other).

Panics

Panics if other is zero.

pub fn pow(self, expon: Self) -> Self

Fast exponentiation by squaring https://en.wikipedia.org/wiki/Exponentiation_by_squaring

Panics

Panics if the result overflows the type.

pub fn overflowing_pow(self, expon: Self) -> (Self, bool)

Fast exponentiation by squaring. Returns result and overflow flag.

pub fn overflowing_add(self, other: MaxFieldUint) -> (MaxFieldUint, bool)

Add with overflow.

pub fn saturating_add(self, other: MaxFieldUint) -> MaxFieldUint

Addition which saturates at the maximum value (Self::max_value()).

pub fn checked_add(self, other: MaxFieldUint) -> Option<MaxFieldUint>

Checked addition. Returns None if overflow occurred.

pub fn overflowing_sub(self, other: MaxFieldUint) -> (MaxFieldUint, bool)

Subtraction which underflows and returns a flag if it does.

pub fn saturating_sub(self, other: MaxFieldUint) -> MaxFieldUint

Subtraction which saturates at zero.

pub fn checked_sub(self, other: MaxFieldUint) -> Option<MaxFieldUint>

Checked subtraction. Returns None if overflow occurred.

pub fn adaptive_multiplication(self, other: MaxFieldUint) -> MaxFieldUint

Multiply without overflow by checking number of words for each input

pub fn overflowing_mul(self, other: MaxFieldUint) -> (MaxFieldUint, bool)

Multiply with overflow, returning a flag if it does.

pub fn saturating_mul(self, other: MaxFieldUint) -> MaxFieldUint

Multiplication which saturates at the maximum value..

pub fn checked_mul(self, other: MaxFieldUint) -> Option<MaxFieldUint>

Checked multiplication. Returns None if overflow occurred.

pub fn checked_div(self, other: MaxFieldUint) -> Option<MaxFieldUint>

Checked division. Returns None if other == 0.

pub fn checked_rem(self, other: MaxFieldUint) -> Option<MaxFieldUint>

Checked modulus. Returns None if other == 0.

pub fn overflowing_neg(self) -> (MaxFieldUint, bool)

Negation with overflow.

pub fn checked_neg(self) -> Option<MaxFieldUint>

Checked negation. Returns None unless self == 0.

pub fn from_big_endian(slice: &[u8]) -> Self

Converts from big endian representation bytes in memory.

pub fn from_little_endian(slice: &[u8]) -> Self

Converts from little endian representation bytes in memory.

impl MaxFieldUint

pub fn low_u128(&self) -> u128

Low 2 words (u128)

pub fn as_u128(&self) -> u128

Conversion to u128 with overflow checking

Panics

Panics if the number is larger than 2^128.

Trait Implementations

impl Add<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<MaxFieldUint> for MaxFieldUint

fn add_assign(&mut self, other: MaxFieldUint)

Performs the += operation.

impl AsMut<[u64]> for MaxFieldUint

Get a mutable reference to the underlying little-endian words.

fn as_mut(&mut self) -> &mut [u64]

Performs the conversion.

impl AsRef<[u64]> for MaxFieldUint

Get a reference to the underlying little-endian words.

fn as_ref(&self) -> &[u64]

Performs the conversion.

impl BitAnd<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the & operator.

fn bitand(self, other: MaxFieldUint) -> MaxFieldUint

Performs the & operation.

impl BitOr<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the | operator.

fn bitor(self, other: MaxFieldUint) -> MaxFieldUint

Performs the | operation.

impl BitXor<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the ^ operator.

fn bitxor(self, other: MaxFieldUint) -> MaxFieldUint

Performs the ^ operation.

impl Clone for MaxFieldUint

fn clone(&self) -> MaxFieldUint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaxFieldUint

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

Formats the value using the given formatter.

impl Default for MaxFieldUint

fn default() -> Self

Returns the “default value” for a type.

impl Display for MaxFieldUint

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

Formats the value using the given formatter.

impl Div<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the / operator.

fn div(self, other: MaxFieldUint) -> MaxFieldUint

Performs the / operation.

impl DivAssign<MaxFieldUint> for MaxFieldUint

fn div_assign(&mut self, other: MaxFieldUint)

Performs the /= operation.

impl From<&'_ [u64]> for MaxFieldUint

fn from(value: &[u64]) -> MaxFieldUint

Performs the conversion.

impl<'a> From<&'a [u8; 128]> for MaxFieldUint

fn from(bytes: &[u8; 128]) -> Self

Performs the conversion.

impl<'a> From<&'a MaxFieldUint> for MaxFieldUint

fn from(x: &'a MaxFieldUint) -> MaxFieldUint

Performs the conversion.

impl From<[u8; 128]> for MaxFieldUint

fn from(bytes: [u8; 128]) -> Self

Performs the conversion.

impl From<MaxFieldUint> for [u8; 128]

fn from(number: MaxFieldUint) -> Self

Performs the conversion.

impl From<i32> for MaxFieldUint

fn from(value: i32) -> MaxFieldUint

Performs the conversion.

impl From<i64> for MaxFieldUint

fn from(value: i64) -> MaxFieldUint

Performs the conversion.

impl From<isize> for MaxFieldUint

fn from(value: isize) -> MaxFieldUint

Performs the conversion.

impl From<u128> for MaxFieldUint

fn from(value: u128) -> MaxFieldUint

Performs the conversion.

impl From<u16> for MaxFieldUint

fn from(value: u16) -> MaxFieldUint

Performs the conversion.

impl From<u32> for MaxFieldUint

fn from(value: u32) -> MaxFieldUint

Performs the conversion.

impl From<u64> for MaxFieldUint

fn from(value: u64) -> MaxFieldUint

Performs the conversion.

impl From<u8> for MaxFieldUint

fn from(value: u8) -> MaxFieldUint

Performs the conversion.

impl From<usize> for MaxFieldUint

fn from(value: usize) -> MaxFieldUint

Performs the conversion.

impl Hash for MaxFieldUint

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

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

Formats the value using the given formatter.

impl<'a> Mul<&'a MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: &'a MaxFieldUint) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<&'a MaxFieldUint> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: &'a MaxFieldUint) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<&'a u64> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: &'a u64) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<&'a u64> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: &'a u64) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<&'a usize> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: &'a usize) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<&'a usize> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: &'a usize) -> MaxFieldUint

Performs the * operation.

impl Mul<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: MaxFieldUint) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<MaxFieldUint> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: MaxFieldUint) -> MaxFieldUint

Performs the * operation.

impl Mul<u64> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: u64) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<u64> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: u64) -> MaxFieldUint

Performs the * operation.

impl Mul<usize> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: usize) -> MaxFieldUint

Performs the * operation.

impl<'a> Mul<usize> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the * operator.

fn mul(self, other: usize) -> MaxFieldUint

Performs the * operation.

impl MulAssign<MaxFieldUint> for MaxFieldUint

fn mul_assign(&mut self, other: MaxFieldUint)

Performs the *= operation.

impl MulAssign<u64> for MaxFieldUint

fn mul_assign(&mut self, other: u64)

Performs the *= operation.

impl MulAssign<usize> for MaxFieldUint

fn mul_assign(&mut self, other: usize)

Performs the *= operation.

impl Not for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the ! operator.

fn not(self) -> MaxFieldUint

Performs the unary ! operation.

impl Ord for MaxFieldUint

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<MaxFieldUint> for MaxFieldUint

fn eq(&self, other: &MaxFieldUint) -> 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 !=.

impl PartialOrd<MaxFieldUint> for MaxFieldUint

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

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

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

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

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

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

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

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

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 Rem<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<MaxFieldUint> for MaxFieldUint

fn rem_assign(&mut self, other: MaxFieldUint)

Performs the %= operation.

impl Shl<u32> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the << operator.

fn shl(self, shift: u32) -> MaxFieldUint

Performs the << operation.

impl<'a> Shl<u32> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the << operator.

fn shl(self, shift: u32) -> MaxFieldUint

Performs the << operation.

impl ShlAssign<u32> for MaxFieldUint

fn shl_assign(&mut self, shift: u32)

Performs the <<= operation.

impl Shr<u32> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the >> operator.

fn shr(self, shift: u32) -> MaxFieldUint

Performs the >> operation.

impl<'a> Shr<u32> for &'a MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the >> operator.

fn shr(self, shift: u32) -> MaxFieldUint

Performs the >> operation.

impl ShrAssign<u32> for MaxFieldUint

fn shr_assign(&mut self, shift: u32)

Performs the >>= operation.

impl Sub<MaxFieldUint> for MaxFieldUint

type Output = MaxFieldUint

The resulting type after applying the - operator.

fn sub(self, other: MaxFieldUint) -> MaxFieldUint

Performs the - operation.

impl SubAssign<MaxFieldUint> for MaxFieldUint

fn sub_assign(&mut self, other: MaxFieldUint)

Performs the -= operation.

impl Copy for MaxFieldUint

impl Eq for MaxFieldUint