Struct ruint::Uint

pub struct Uint<const BITS: usize, const LIMBS: usize> { /* private fields */ }

The ring of numbers modulo $2^{\mathtt{BITS}}$.

Uint implements nearly all traits and methods from the std unsigned integer types, including most nightly only ones.

Notable differences from std uint types.

• The operators +, -, *, etc. using wrapping math by default. The std operators panic on overflow in debug, and are undefined in release, see reference.
• The Uint::checked_shl, Uint::overflowing_shl, etc return overflow when non-zero bits are shifted out. In std they return overflow when the shift amount is greater than the bit size.
• Some methods like u64::div_euclid and u64::rem_euclid are left out because they are meaningless or redundant for unsigned integers. Std has them for compatibility with their signed integers.
• Many functions that are const in std are not in Uint.
• Uint::to_le_bytes and Uint::to_be_bytes require the output size to be provided as a const-generic argument. They will runtime panic if the provided size is incorrect.
• Uint::widening_mul takes as argument an Uint of arbitrary size and returns a result that is sized to fit the product without overflow (i.e. the sum of the bit sizes of self and the argument). The std version requires same-sized arguments and returns a pair of lower and higher bits.

Implementations

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

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

Computes the absolute difference between self and other.

Returns $\left\vert \mathtt{self} - \mathtt{other} \right\vert$.

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

Computes self + rhs, returning None if overflow occurred.

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

Computes -self, returning None unless self == 0.

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

Computes self - rhs, returning None if overflow occurred.

pub fn overflowing_add(self, rhs: Self) -> (Self, bool)

Calculates $\mod{\mathtt{self} + \mathtt{rhs}}_{2^{BITS}}$.

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 overflowing_neg(self) -> (Self, bool)

Calculates $\mod{-\mathtt{self}}_{2^{BITS}}$.

Returns !self + 1 using wrapping operations to return the value that represents the negation of this unsigned value. Note that for positive unsigned values overflow always occurs, but negating 0 does not overflow.

pub fn overflowing_sub(self, rhs: Self) -> (Self, bool)

Calculates $\mod{\mathtt{self} - \mathtt{rhs}}_{2^{BITS}}$.

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 saturating_add(self, rhs: Self) -> Self

Computes self + rhs, saturating at the numeric bounds instead of overflowing.

pub fn saturating_sub(self, rhs: Self) -> Self

Computes self - rhs, saturating at the numeric bounds instead of overflowing

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

Computes self + rhs, wrapping around at the boundary of the type.

pub fn wrapping_neg(self) -> Self

Computes -self, wrapping around at the boundary of the type.

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

Computes self - rhs, wrapping around at the boundary of the type.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn to_base_le(&self, base: u64) -> impl Iterator<Item = u64>

Returns an iterator over the base base digits of the number in little-endian order.

Pro tip: instead of setting base = 10, set it to the highest power of 10 that still fits u64. This way much fewer iterations are required to extract all the digits.

Panics

Panics if the base is less than 2.

pub fn to_base_be(&self, base: u64) -> impl Iterator<Item = u64>

Returns an iterator over the base base digits of the number in big-endian order.

Pro tip: instead of setting base = 10, set it to the highest power of 10 that still fits u64. This way much fewer iterations are required to extract all the digits.

Panics

Panics if the base is less than 2.

pub fn from_base_le<I: IntoIterator<Item = u64>>(
    base: u64,
    digits: I
) -> Result<Self, BaseConvertError>

Constructs the Uint from digits in the base base in little-endian.

Errors

• BaseConvertError::InvalidBase if the base is less than 2.
• BaseConvertError::InvalidDigit if a digit is out of range.
• BaseConvertError::Overflow if the number is too large to fit.

pub fn from_base_be<I: IntoIterator<Item = u64>>(
    base: u64,
    digits: I
) -> Result<Self, BaseConvertError>

Constructs the Uint from digits in the base base in big-endian.

Errors

• BaseConvertError::InvalidBase if the base is less than 2.
• BaseConvertError::InvalidDigit if a digit is out of range.
• BaseConvertError::Overflow if the number is too large to fit.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

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

pub fn set_bit(&mut self, index: usize, value: bool)

pub fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

pub fn leading_zeros(&self) -> usize

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

pub fn leading_ones(&self) -> usize

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

pub fn trailing_zeros(&self) -> usize

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

pub fn trailing_ones(&self) -> usize

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

pub fn count_ones(&self) -> usize

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

pub fn count_zeros(&self) -> usize

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

pub fn bit_len(&self) -> usize

Length of the number in bits ignoring leading zeros.

pub fn byte_len(&self) -> usize

Length of the number in bytes ignoring leading zeros.

pub fn most_significant_bits(&self) -> (u64, usize)

Returns the most significant 64 bits of the number and the exponent.

Given return value $(\mathtt{bits}, \mathtt{exponent})$, the self can be approximated as

$$ \mathtt{self} ≈ \mathtt{bits} ⋅ 2^\mathtt{exponent} $$

If self is $<≥> 2^{63}$, then exponent will be zero and bits will have leading zeros.

pub fn checked_shl(self, rhs: usize) -> Option<Self>

Checked left shift by rhs bits.

Returns $\mathtt{self} ⋅ 2^{\mathtt{rhs}}$ or None if the result would $≥ 2^{\mathtt{BITS}}$. That is, it returns None if the bits shifted out would be non-zero.

Note: This differs from u64::checked_shl which returns None if the shift is larger than BITS (which is IMHO not very useful).

pub fn saturating_shl(self, rhs: usize) -> Self

Saturating left shift by rhs bits.

Returns $\mathtt{self} ⋅ 2^{\mathtt{rhs}}$ or Uint::MAX if the result would $≥ 2^{\mathtt{BITS}}$. That is, it returns Uint::MAX if the bits shifted out would be non-zero.

pub fn overflowing_shl(self, rhs: usize) -> (Self, bool)

Left shift by rhs bits with overflow detection.

Returns $\mod{\mathtt{value} ⋅ 2^{\mathtt{rhs}}}_{2^{\mathtt{BITS}}}$. If the product is $≥ 2^{\mathtt{BITS}}$ it returns true. That is, it returns true if the bits shifted out are non-zero.

Note: This differs from u64::overflowing_shl which returns true if the shift is larger than BITS (which is IMHO not very useful).

pub fn wrapping_shl(self, rhs: usize) -> Self

Left shift by rhs bits.

Returns $\mod{\mathtt{value} ⋅ 2^{\mathtt{rhs}}}_{2^{\mathtt{BITS}}}$.

Note: This differs from u64::wrapping_shl which first reduces rhs by BITS (which is IMHO not very useful).

pub fn checked_shr(self, rhs: usize) -> Option<Self>

Checked right shift by rhs bits.

$$ \frac{\mathtt{self}}{2^{\mathtt{rhs}}} $$

Returns the above or None if the division is not exact. This is the same as

Note: This differs from u64::checked_shr which returns None if the shift is larger than BITS (which is IMHO not very useful).

pub fn overflowing_shr(self, rhs: usize) -> (Self, bool)

Right shift by rhs bits with underflow detection.

$$ \floor{\frac{\mathtt{self}}{2^{\mathtt{rhs}}}} $$

Returns the above and false if the division was exact, and true if it was rounded down. This is the same as non-zero bits being shifted out.

Note: This differs from u64::overflowing_shl which returns true if the shift is larger than BITS (which is IMHO not very useful).

pub fn wrapping_shr(self, rhs: usize) -> Self

Right shift by rhs bits.

$$ \mathtt{wrapping\_shr}(\mathtt{self}, \mathtt{rhs}) = \floor{\frac{\mathtt{self}}{2^{\mathtt{rhs}}}} $$

Note: This differs from u64::wrapping_shr which first reduces rhs by BITS (which is IMHO not very useful).

pub fn rotate_left(self, rhs: usize) -> Self

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

pub fn rotate_right(self, rhs: usize) -> Self

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub const BYTES: usize = (BITS + 7) / 8

The size of this integer type in bytes. Note that some bits may be forced zero if BITS is not cleanly divisible by eight.

pub fn as_le_slice(&self) -> &[u8]

Access the underlying store as a little-endian slice of bytes.

Only available on litte-endian targets.

If BITS does not evenly divide 8, it is padded with zero bits in the most significant position.

pub unsafe fn as_le_slice_mut(&mut self) -> &mut [u8]

Access the underlying store as a mutable little-endian slice of bytes.

Only available on litte-endian targets.

Safety

If BITS does not evenly divide 8, it is padded with zero bits in the most significant position. Setting those bits puts the Uint in an invalid state.

pub fn as_le_bytes(&self) -> Cow<'_, [u8]>

Access the underlying store as a little-endian bytes.

Uses an optimized implementation on little-endian targets.

pub fn as_le_bytes_trimmed(&self) -> Cow<'_, [u8]>

Access the underlying store as a little-endian bytes with trailing zeros removed.

Uses an optimized implementation on little-endian targets.

pub fn to_le_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

Converts the Uint to a little-endian byte array of size exactly Self::BYTES.

Panics

Panics if the generic parameter BYTES is not exactly Self::BYTES. Ideally this would be a compile time error, but this is blocked by Rust issue #60551.

pub fn to_le_bytes_vec(&self) -> Vec<u8>

Converts the Uint to a little-endian byte vector of size exactly Self::BYTES.

This method is useful when Self::to_le_bytes can not be used because byte size is not known compile time.

pub fn to_le_bytes_trimmed_vec(&self) -> Vec<u8>

Converts the Uint to a little-endian byte vector with trailing zeros bytes removed.

pub fn to_be_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

Converts the Uint to a big-endian byte array of size exactly Self::BYTES.

Panics

Panics if the generic parameter BYTES is not exactly Self::BYTES. Ideally this would be a compile time error, but this is blocked by Rust issue #60551.

pub fn to_be_bytes_vec(&self) -> Vec<u8>

Converts the Uint to a big-endian byte vector of size exactly Self::BYTES.

This method is useful when Self::to_be_bytes can not be used because byte size is not known compile time.

pub fn to_be_bytes_trimmed_vec(&self) -> Vec<u8>

Converts the Uint to a big-endian byte vector with leading zeros bytes removed.

pub fn try_from_be_slice(bytes: &[u8]) -> Option<Self>

Creates a new integer from a big endian slice of bytes.

The slice is interpreted as a big endian number. Leading zeros are ignored. The slice can be any length.

Returns None if the value is larger than fits the Uint.

pub fn try_from_le_slice(bytes: &[u8]) -> Option<Self>

Creates a new integer from a little endian slice of bytes.

The slice is interpreted as a little endian number. Leading zeros are ignored. The slice can be any length.

Returns None if the value is larger than fits the Uint.

pub fn from_be_bytes<const BYTES: usize>(bytes: [u8; BYTES]) -> Self

Converts a big-endian byte array of size exactly Self::BYTES to Uint.

Panics

Panics if the generic parameter BYTES is not exactly Self::BYTES. Ideally this would be a compile time error, but this is blocked by Rust issue #60551.

Panics if the value is too large for the bit-size of the Uint.

pub fn from_le_bytes<const BYTES: usize>(bytes: [u8; BYTES]) -> Self

Converts a little-endian byte array of size exactly Self::BYTES to Uint.

Panics

Panics if the generic parameter BYTES is not exactly Self::BYTES. Ideally this would be a compile time error, but this is blocked by Rust issue #60551.

Panics if the value is too large for the bit-size of the Uint.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

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

Computes self / rhs, returning None if rhs == 0.

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

Computes self % rhs, returning None if rhs == 0.

pub fn div_ceil(self, rhs: Self) -> Self

Computes self / rhs rounding up.

Panics

Panics if rhs == 0.

pub fn div_rem(self, rhs: Self) -> (Self, Self)

Computes self / rhs and self % rhs.

Panics

Panics if rhs == 0.

pub fn wrapping_div(self, rhs: Self) -> Self

Computes self / rhs rounding down.

Panics

Panics if rhs == 0.

pub fn wrapping_rem(self, rhs: Self) -> Self

Computes self % rhs.

Panics

Panics if rhs == 0.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn from<T>(value: T) -> Self where
    Self: TryFrom<T>,
    <Self as TryFrom<T>>::Error: Display, 

Panics

Panics if the conversion fails, for example if the value is too large for the bit-size of the Uint. The panic will be attributed to the call site.

pub fn checked_from_uint<const BITS_SRC: usize, const LIMBS_SRC: usize>(
    value: Uint<BITS_SRC, LIMBS_SRC>
) -> Option<Self>

pub fn from_uint<const BITS_SRC: usize, const LIMBS_SRC: usize>(
    value: Uint<BITS_SRC, LIMBS_SRC>
) -> Self

Panics

Panics if the value is too large for the target type.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

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

Compute the greatest common divisor of two Uints.

Examples

assert_eq!(0_U128.gcd(0_U128), 0_U128);

pub fn lcm(self, other: Self) -> Option<Self>

Compute the least common multiple of two Uints or None if the result would be too large.

pub fn gcd_extended(self, other: Self) -> (Self, Self, Self, bool)

⚠️ Compute the greatest common divisor and the Bézout coefficients.

Warning. This is API is unstable and may change in a minor release.

Returns $(\mathtt{gcd}, \mathtt{x}, \mathtt{y}, \mathtt{sign})$ such that

$$ \gcd(\mathtt{self}, \mathtt{other}) = \mathtt{gcd} = \begin{cases} \mathtt{self} · \mathtt{x} - \mathtt{other} . \mathtt{y} & \mathtt{sign} \\ \mathtt{other} · \mathtt{y} - \mathtt{self} · \mathtt{x} & ¬\mathtt{sign} \end{cases} $$

Note that the intermediate products may overflow, even though the result after subtraction will fit in the bit size of the Uint.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn checked_log(self, base: u64) -> Option<usize>

pub fn checked_log10(self) -> Option<usize>

pub fn checked_log2(self) -> Option<usize>

Returns the base 2 logarithm of the number, rounded down.

This is equivalent to the index of the highest set bit.

Returns None if the number is zero.

pub fn log(self, base: u64) -> usize

Panics

Panics if the base is less than 2 or if the number is zero.

pub fn log10(self) -> usize

pub fn log2(self) -> usize

pub fn approx_log(self, base: f64) -> f64

Double precision logarithm.

pub fn approx_log2(self) -> f64

Double precision binary logarithm.

Examples

assert_eq!(0_U64.approx_log2(), f64::NEG_INFINITY);
assert_eq!(1_U64.approx_log2(), 0.0);
assert_eq!(2_U64.approx_log2(), 1.0);
assert_eq!(U64::MAX.approx_log2(), 64.0);

pub fn approx_log10(self) -> f64

Double precision decimal logarithm.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn reduce_mod(self, modulus: Self) -> Self

⚠️ Compute $\mod{\mathtt{self}}_{\mathtt{modulus}}$.

Warning. This function is not part of the stable API.

Returns zero if the modulus is zero.

pub fn add_mod(self, rhs: Self, modulus: Self) -> Self

Compute $\mod{\mathtt{self} + \mathtt{rhs}}_{\mathtt{modulus}}$.

Returns zero if the modulus is zero.

pub fn mul_mod(self, rhs: Self, modulus: Self) -> Self

Compute $\mod{\mathtt{self} ⋅ \mathtt{rhs}}_{\mathtt{modulus}}$.

Returns zero if the modulus is zero.

See mul_redc for a faster variant at the cost of some pre-computation.

pub fn pow_mod(self, exp: Self, modulus: Self) -> Self

Compute $\mod{\mathtt{self}^{\mathtt{rhs}}}_{\mathtt{modulus}}$.

Returns zero if the modulus is zero.

pub fn inv_mod(self, modulus: Self) -> Option<Self>

Compute $\mod{\mathtt{self}^{-1}}_{\mathtt{modulus}}$.

Returns None if the inverse does not exist.

pub fn mul_redc(self, other: Self, modulus: Self, inv: u64) -> Self

Montgomery multiplication.

Computes

$$ \mod{\frac{\mathtt{self} ⋅ \mathtt{other}}{ 2^{64 · \mathtt{LIMBS}}}}_{\mathtt{modulus}} $$

This is useful because it can be computed notably faster than mul_mod. Many computations can be done by pre-multiplying values with $R = 2^{64 · \mathtt{LIMBS}}$ and then using mul_redc instead of mul_mod.

For this algorithm to work, it needs an extra parameter inv which must be set to

$$ \mathtt{inv} = \mod{\frac{-1}{\mathtt{modulus}} }_{2^{64}} $$

The inv value only exists for odd values of modulus. It can be computed using inv_ring from U64.

let inv = (-U64::from(modulus.as_limbs()[0]).inv_ring().unwrap()).as_limbs()[0];

Panics

Panics if inv is not correct.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

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

Computes self * rhs, returning None if overflow occurred.

pub fn overflowing_mul(self, rhs: Self) -> (Self, bool)

Calculates the multiplication of self and 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.

Examples

assert_eq!(1_U1.overflowing_mul(1_U1), (1_U1, false));
assert_eq!(0x010000000000000000_U65.overflowing_mul(0x010000000000000000_U65), (0x000000000000000000_U65, true));

pub fn saturating_mul(self, rhs: Self) -> Self

Computes self * rhs, saturating at the numeric bounds instead of overflowing.

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

Computes self * rhs, saturating at the numeric bounds instead of overflowing.

pub fn inv_ring(self) -> Option<Self>

Computes the inverse modulo $2^{\mathtt{BITS}}$ of self, returning None if the inverse does not exist.

pub fn widening_mul<const BITS_RHS: usize, const LIMBS_RHS: usize, const BITS_RES: usize, const LIMBS_RES: usize>(
    self,
    rhs: Uint<BITS_RHS, LIMBS_RHS>
) -> Uint<BITS_RES, LIMBS_RES>

Calculates the complete product self * rhs without the possibility to overflow.

The argument rhs can be any size Uint, the result size is the sum of the bit-sizes of self and rhs.

Panics

This function will runtime panic of the const generic arguments are incorrect.

Examples

assert_eq!(0_U0.widening_mul(0_U0), 0_U0);
assert_eq!(1_U1.widening_mul(1_U1), 1_U2);
assert_eq!(3_U2.widening_mul(7_U3), 21_U5);

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn checked_pow(self, exp: usize) -> Option<Self>

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

Examples

assert_eq!(36_U64.overflowing_pow(12), (0x41c21cb8e1000000_U64, false));
assert_eq!(36_U64.overflowing_pow(13), (0x3f4c09ffa4000000_U64, true));
assert_eq!(36_U68.overflowing_pow(13), (0x093f4c09ffa4000000_U68, false));
assert_eq!(16_U65.overflowing_pow(32), (0_U65, true));

Small cases:

assert_eq!(0_U0.overflowing_pow(0), (0_U0, false));
assert_eq!(0_U1.overflowing_pow(0), (1_U1, false));
assert_eq!(0_U1.overflowing_pow(1), (0_U1, false));
assert_eq!(1_U1.overflowing_pow(0), (1_U1, false));
assert_eq!(1_U1.overflowing_pow(1), (1_U1, false));

pub fn pow(self, exp: usize) -> Self

pub fn saturating_pow(self, exp: usize) -> Self

pub fn wrapping_pow(self, exp: usize) -> Self

pub fn approx_pow2(exp: f64) -> Option<Self>

Construct from double precision binary logarithm.

Examples

assert_eq!(U64::approx_pow2(-2.0), Some(0_U64));
assert_eq!(U64::approx_pow2(-1.0), Some(1_U64));
assert_eq!(U64::approx_pow2(0.0), Some(1_U64));
assert_eq!(U64::approx_pow2(1.0), Some(2_U64));
assert_eq!(U64::approx_pow2(1.6), Some(3_U64));
assert_eq!(U64::approx_pow2(2.0), Some(4_U64));
assert_eq!(U64::approx_pow2(64.0), None);
assert_eq!(U64::approx_pow2(10.385), Some(1337_U64));

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn root(self, degree: usize) -> Self

Computes the floor of the degree-th root of the number.

$$ \floor{\sqrt[\mathtt{degree}]{\mathtt{self}}} $$

Panics

Panics if degree is zero.

Examples

assert_eq!(0_U64.root(2), 0_U64);
assert_eq!(1_U64.root(63), 1_U64);
assert_eq!(0x0032da8b0f88575d_U63.root(64), 1_U63);
assert_eq!(0x1756800000000000_U63.root(34), 3_U63);

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

pub fn next_power_of_two(self) -> Self

Returns the smallest power of two greater than or equal to self.

Panics

Panics if the value overlfows.

pub fn checked_next_power_of_two(self) -> Option<Self>

Returns the smallest power of two greater than or equal to self. If the next power of two is greater than the type’s maximum value, None is returned, otherwise the power of two is wrapped in Some.

Examples

assert_eq!(0_U64.checked_next_power_of_two(), Some(1_U64));
assert_eq!(1_U64.checked_next_power_of_two(), Some(1_U64));
assert_eq!(2_U64.checked_next_power_of_two(), Some(2_U64));
assert_eq!(3_U64.checked_next_power_of_two(), Some(4_U64));
assert_eq!(U64::MAX.checked_next_power_of_two(), None);

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn next_multiple_of(self, rhs: Self) -> Self

Calculates the smallest value greater than or equal to self that is a multiple of rhs.

Panics

This function will panic if rhs is 0 or the operation results in overflow.

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

Calculates the smallest value greater than or equal to self that is a multiple of rhs. Returns None is rhs is zero or the operation would result in overflow.

Examples

assert_eq!(16_U64.checked_next_multiple_of(8_U64), Some(16_U64));
assert_eq!(23_U64.checked_next_multiple_of(8_U64), Some(24_U64));
assert_eq!(1_U64.checked_next_multiple_of(0_U64), None);
assert_eq!(U64::MAX.checked_next_multiple_of(2_U64), None);
}

assert_eq!(0_U0.checked_next_multiple_of(0_U0), None);
assert_eq!(0_U1.checked_next_multiple_of(0_U1), None);
assert_eq!(0_U1.checked_next_multiple_of(1_U1), Some(0_U1));
assert_eq!(1_U1.checked_next_multiple_of(0_U1), None);
assert_eq!(1_U1.checked_next_multiple_of(1_U1), Some(1_U1));
}

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub fn from_str_radix(src: &str, radix: u64) -> Result<Self, ParseError>

Parse a string into a Uint.

For bases 2 to 36, the case-agnostic alphabet 0—1, a—b is used and _ are ignored. For bases 37 to 64, the case-sensitive alphabet a—z, A—Z, 0—9, {+-}, {/,_} is used. That is, for base 64 it is compatible with all the common base64 variants.

Errors

• ParseError::InvalidDigit if the string contains a non-digit.
• ParseError::InvalidRadix if the radix is larger than 64.
• ParseError::BaseConvertError if Uint::from_base_be fails.

impl<const BITS: usize, const LIMBS: usize> Uint<BITS, LIMBS>

pub const LIMBS: usize = nlimbs(BITS)

The size of this integer type in 64-bit limbs.

pub const BITS: usize = BITS

The size of this integer type in bits.

pub const MIN: Self = Self::ZERO

The smallest value that can be represented by this integer type. Synonym for Self::ZERO.

pub const ZERO: Self = Self { limbs: [0; LIMBS] }

The value zero. This is the only value that exists in all Uint types.

pub const MAX: Self = { let mut limbs = [u64::MAX; LIMBS]; if BITS > 0 { limbs[LIMBS - 1] &= Self::MASK; } Self { limbs } }

The largest value that can be represented by this integer type, $2^{\mathtt{BITS}} − 1$.

pub const fn as_limbs(&self) -> &[u64; LIMBS]

View the array of limbs.

pub unsafe fn as_limbs_mut(&mut self) -> &mut [u64; LIMBS]

Access the array of limbs.

Safety

This function is unsafe because it allows setting a bit outside the bit size if the bit-size is not limb-aligned.

pub const fn into_limbs(self) -> [u64; LIMBS]

Convert to a array of limbs.

Limbs are least significant first.

pub const fn from_limbs(limbs: [u64; LIMBS]) -> Self

Construct a new integer from little-endian a array of limbs.

Panics

Panics it LIMBS is not equal to nlimbs(BITS).

Panics if the value is to large for the bit-size of the Uint.

pub fn from_limbs_slice(slice: &[u64]) -> Self

Construct a new integer from little-endian a slice of limbs.

Panics

Panics if the value is to large for the bit-size of the Uint.

pub fn checked_from_limbs_slice(slice: &[u64]) -> Option<Self>

Construct a new integer from little-endian a slice of limbs, or None if the value is too large for the Uint.

Trait Implementations

impl<const BITS: usize, const LIMBS: usize> Add<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the + operator.

fn add(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the + operation.

impl<const BITS: usize, const LIMBS: usize> Add<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the + operator.

fn add(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the + operation.

impl<const BITS: usize, const LIMBS: usize> Add<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the + operator.

fn add(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the + operation.

impl<const BITS: usize, const LIMBS: usize> Add<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the + operator.

fn add(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the + operation.

impl<const BITS: usize, const LIMBS: usize> AddAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn add_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the += operation.

impl<const BITS: usize, const LIMBS: usize> AddAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn add_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the += operation.

impl<const BITS: usize, const LIMBS: usize> Arbitrary for Uint<BITS, LIMBS>

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Uint<BITS, LIMBS>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_: Self::Parameters) -> BoxedStrategy<Self>

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<'a, const BITS: usize, const LIMBS: usize> Arbitrary<'a> for Uint<BITS, LIMBS>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn size_hint(_depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

impl<const BITS: usize, const LIMBS: usize> Arbitrary for Uint<BITS, LIMBS>

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static, Global>

Return an iterator of values that are smaller than itself.

impl<const BITS: usize, const LIMBS: usize> Binary for Uint<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> BitAnd<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAnd<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAnd<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAnd<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAndAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn bitand_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the &= operation.

impl<const BITS: usize, const LIMBS: usize> BitAndAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn bitand_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the &= operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOrAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn bitor_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the |= operation.

impl<const BITS: usize, const LIMBS: usize> BitOrAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn bitor_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the |= operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXorAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn bitxor_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the ^= operation.

impl<const BITS: usize, const LIMBS: usize> BitXorAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn bitxor_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the ^= operation.

impl<const BITS: usize, const LIMBS: usize> Clone for Uint<BITS, LIMBS>

fn clone(&self) -> Uint<BITS, LIMBS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const BITS: usize, const LIMBS: usize> Debug for Uint<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> Decodable for Uint<BITS, LIMBS>

Allows a Uint to be deserialized from RLP.

See https://eth.wiki/en/fundamentals/rlp

fn decode(buf: &mut &[u8]) -> Result<Self, DecodeError>

impl<const BITS: usize, const LIMBS: usize> Decodable for Uint<BITS, LIMBS>

Allows a Uint to be deserialized from RLP.

See https://eth.wiki/en/fundamentals/rlp

fn decode(s: &Rlp<'_>) -> Result<Self, DecoderError>

Decode a value from RLP bytes

impl<'a, const BITS: usize, const LIMBS: usize, DB: Database> Decode<'a, DB> for Uint<BITS, LIMBS> where
    Vec<u8>: Decode<'a, DB>, 

fn decode(value: <DB as HasValueRef<'a>>::ValueRef) -> Result<Self, BoxDynError>

Decode a new value of this type using a raw value from the database.

impl<const BITS: usize, const LIMBS: usize> Default for Uint<BITS, LIMBS>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const BITS: usize, const LIMBS: usize> Deserialize<'de> for Uint<BITS, LIMBS>

Deserialize human readable hex strings or byte arrays into hashes. Hex strings can be upper/lower/mixed case, have an optional 0x prefix, and can be any length. They are interpreted big-endian.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<const BITS: usize, const LIMBS: usize> Display for Uint<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> Distribution<Uint<BITS, LIMBS>> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Uint<BITS, LIMBS>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
    F: Fn(T) -> S, 

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<const BITS: usize, const LIMBS: usize> Div<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the / operation.

impl<const BITS: usize, const LIMBS: usize> Div<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the / operation.

impl<const BITS: usize, const LIMBS: usize> Div<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the / operation.

impl<const BITS: usize, const LIMBS: usize> Div<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the / operation.

impl<const BITS: usize, const LIMBS: usize> DivAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn div_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the /= operation.

impl<const BITS: usize, const LIMBS: usize> DivAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn div_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the /= operation.

impl<const BITS: usize, const LIMBS: usize> Encodable for Uint<BITS, LIMBS>

Allows a Uint to be serialized as RLP.

See https://eth.wiki/en/fundamentals/rlp

fn length(&self) -> usize

fn encode(&self, out: &mut dyn BufMut)

impl<const BITS: usize, const LIMBS: usize> Encodable for Uint<BITS, LIMBS>

Allows a Uint to be serialized as RLP.

See https://eth.wiki/en/fundamentals/rlp

fn rlp_append(&self, s: &mut RlpStream)

Append a value to the stream

fn rlp_bytes(&self) -> BytesMut

Get rlp-encoded bytes for this instance

impl<'a, const BITS: usize, const LIMBS: usize, DB: Database> Encode<'a, DB> for Uint<BITS, LIMBS> where
    Vec<u8>: Encode<'a, DB>, 

fn encode_by_ref(
    &self,
    buf: &mut <DB as HasArguments<'a>>::ArgumentBuffer
) -> IsNull

Writes the value of self into buf without moving self.

fn encode(self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer) -> IsNull

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl From<&'_ BigInteger128> for Uint<128, 2>

fn from(value: &BigInteger128) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger256> for Uint<256, 4>

fn from(value: &BigInteger256) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger320> for Uint<320, 5>

fn from(value: &BigInteger320) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger384> for Uint<384, 6>

fn from(value: &BigInteger384) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger448> for Uint<448, 7>

fn from(value: &BigInteger448) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger64> for Uint<64, 1>

fn from(value: &BigInteger64) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger768> for Uint<768, 12>

fn from(value: &BigInteger768) -> Self

Converts to this type from the input type.

impl From<&'_ BigInteger832> for Uint<832, 13>

fn from(value: &BigInteger832) -> Self

Converts to this type from the input type.

impl<P: Fp256Parameters> From<&'_ Fp256<P>> for Uint<256, 4>

fn from(value: &Fp256<P>) -> Self

Converts to this type from the input type.

impl<P: Fp320Parameters> From<&'_ Fp320<P>> for Uint<320, 5>

fn from(value: &Fp320<P>) -> Self

Converts to this type from the input type.

impl<P: Fp384Parameters> From<&'_ Fp384<P>> for Uint<384, 6>

fn from(value: &Fp384<P>) -> Self

Converts to this type from the input type.

impl<P: Fp448Parameters> From<&'_ Fp448<P>> for Uint<448, 7>

fn from(value: &Fp448<P>) -> Self

Converts to this type from the input type.

impl<P: Fp64Parameters> From<&'_ Fp64<P>> for Uint<64, 1>

fn from(value: &Fp64<P>) -> Self

Converts to this type from the input type.

impl<P: Fp768Parameters> From<&'_ Fp768<P>> for Uint<768, 12>

fn from(value: &Fp768<P>) -> Self

Converts to this type from the input type.

impl<P: Fp832Parameters> From<&'_ Fp832<P>> for Uint<832, 13>

fn from(value: &Fp832<P>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<128_usize, 2_usize>> for BigInteger128

fn from(value: &Uint<128, 2>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<256_usize, 4_usize>> for BigInteger256

fn from(value: &Uint<256, 4>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<320_usize, 5_usize>> for BigInteger320

fn from(value: &Uint<320, 5>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<384_usize, 6_usize>> for BigInteger384

fn from(value: &Uint<384, 6>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<448_usize, 7_usize>> for BigInteger448

fn from(value: &Uint<448, 7>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<64_usize, 1_usize>> for BigInteger64

fn from(value: &Uint<64, 1>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<768_usize, 12_usize>> for BigInteger768

fn from(value: &Uint<768, 12>) -> Self

Converts to this type from the input type.

impl From<&'_ Uint<832_usize, 13_usize>> for BigInteger832

fn from(value: &Uint<832, 13>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<&'_ Uint<BITS, LIMBS>> for f32

fn from(value: &Uint<BITS, LIMBS>) -> Self

Approximate single precision float.

Returns f32::INFINITY if the value is too large to represent.

impl<const BITS: usize, const LIMBS: usize> From<&'_ Uint<BITS, LIMBS>> for f64

fn from(value: &Uint<BITS, LIMBS>) -> Self

Approximate double precision float.

Returns f64::INFINITY if the value is too large to represent.

impl<const BITS: usize, const LIMBS: usize> From<&'_ Uint<BITS, LIMBS>> for BigUint

fn from(value: &Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<&'_ Uint<BITS, LIMBS>> for BigInt

fn from(value: &Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl From<BigInteger128> for Uint<128, 2>

fn from(value: BigInteger128) -> Self

Converts to this type from the input type.

impl From<BigInteger256> for Uint<256, 4>

fn from(value: BigInteger256) -> Self

Converts to this type from the input type.

impl From<BigInteger320> for Uint<320, 5>

fn from(value: BigInteger320) -> Self

Converts to this type from the input type.

impl From<BigInteger384> for Uint<384, 6>

fn from(value: BigInteger384) -> Self

Converts to this type from the input type.

impl From<BigInteger448> for Uint<448, 7>

fn from(value: BigInteger448) -> Self

Converts to this type from the input type.

impl From<BigInteger64> for Uint<64, 1>

fn from(value: BigInteger64) -> Self

Converts to this type from the input type.

impl From<BigInteger768> for Uint<768, 12>

fn from(value: BigInteger768) -> Self

Converts to this type from the input type.

impl From<BigInteger832> for Uint<832, 13>

fn from(value: BigInteger832) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Bits<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn from(x: Bits<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<P: Fp256Parameters> From<Fp256<P>> for Uint<256, 4>

fn from(value: Fp256<P>) -> Self

Converts to this type from the input type.

impl<P: Fp320Parameters> From<Fp320<P>> for Uint<320, 5>

fn from(value: Fp320<P>) -> Self

Converts to this type from the input type.

impl<P: Fp384Parameters> From<Fp384<P>> for Uint<384, 6>

fn from(value: Fp384<P>) -> Self

Converts to this type from the input type.

impl<P: Fp448Parameters> From<Fp448<P>> for Uint<448, 7>

fn from(value: Fp448<P>) -> Self

Converts to this type from the input type.

impl<P: Fp64Parameters> From<Fp64<P>> for Uint<64, 1>

fn from(value: Fp64<P>) -> Self

Converts to this type from the input type.

impl<P: Fp768Parameters> From<Fp768<P>> for Uint<768, 12>

fn from(value: Fp768<P>) -> Self

Converts to this type from the input type.

impl<P: Fp832Parameters> From<Fp832<P>> for Uint<832, 13>

fn from(value: Fp832<P>) -> Self

Converts to this type from the input type.

impl From<Uint<128_usize, 2_usize>> for BigInteger128

fn from(value: Uint<128, 2>) -> Self

Converts to this type from the input type.

impl From<Uint<128_usize, 2_usize>> for U128

fn from(value: U128) -> Self

Converts to this type from the input type.

impl From<Uint<256_usize, 4_usize>> for BigInteger256

fn from(value: Uint<256, 4>) -> Self

Converts to this type from the input type.

impl From<Uint<256_usize, 4_usize>> for U256

fn from(value: U256) -> Self

Converts to this type from the input type.

impl From<Uint<320_usize, 5_usize>> for BigInteger320

fn from(value: Uint<320, 5>) -> Self

Converts to this type from the input type.

impl From<Uint<384_usize, 6_usize>> for BigInteger384

fn from(value: Uint<384, 6>) -> Self

Converts to this type from the input type.

impl From<Uint<448_usize, 7_usize>> for BigInteger448

fn from(value: Uint<448, 7>) -> Self

Converts to this type from the input type.

impl From<Uint<512_usize, 8_usize>> for U512

fn from(value: U512) -> Self

Converts to this type from the input type.

impl From<Uint<64_usize, 1_usize>> for BigInteger64

fn from(value: Uint<64, 1>) -> Self

Converts to this type from the input type.

impl From<Uint<768_usize, 12_usize>> for BigInteger768

fn from(value: Uint<768, 12>) -> Self

Converts to this type from the input type.

impl From<Uint<832_usize, 13_usize>> for BigInteger832

fn from(value: Uint<832, 13>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for Bits<BITS, LIMBS>

fn from(x: Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for f32

fn from(value: Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for f64

fn from(value: Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for BigUint

fn from(value: Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for BigInt

fn from(value: Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

impl<'a, const BITS: usize, const LIMBS: usize> FromSql<'a> for Uint<BITS, LIMBS>

Convert from Postgres types.

See ToSql for details.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be created from the specified Postgres Type.

fn from_sql(
    ty: &Type,
    raw: &'a [u8]
) -> Result<Self, Box<dyn Error + Sync + Send>>

Creates a new value of this type from a buffer of data of the specified Postgres Type in its binary format.

fn from_sql_null(
    ty: &Type
) -> Result<Self, Box<dyn Error + Sync + Send + 'static, Global>>

Creates a new value of this type from a NULL SQL value.

fn from_sql_nullable(
    ty: &Type,
    raw: Option<&'a [u8]>
) -> Result<Self, Box<dyn Error + Sync + Send + 'static, Global>>

A convenience function that delegates to from_sql and from_sql_null depending on the value of raw.

impl<const BITS: usize, const LIMBS: usize> FromStr for Uint<BITS, LIMBS>

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

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

impl<const BITS: usize, const LIMBS: usize> Hash for Uint<BITS, LIMBS>

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<const BITS: usize, const LIMBS: usize> LowerHex for Uint<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> Mul<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the * operator.

fn mul(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the * operation.

impl<const BITS: usize, const LIMBS: usize> Mul<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the * operator.

fn mul(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the * operation.

impl<const BITS: usize, const LIMBS: usize> Mul<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the * operator.

fn mul(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the * operation.

impl<const BITS: usize, const LIMBS: usize> Mul<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the * operator.

fn mul(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the * operation.

impl<const BITS: usize, const LIMBS: usize> MulAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn mul_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the *= operation.

impl<const BITS: usize, const LIMBS: usize> MulAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn mul_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the *= operation.

impl<const BITS: usize, const LIMBS: usize> Neg for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const BITS: usize, const LIMBS: usize> Neg for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const BITS: usize, const LIMBS: usize> Not for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const BITS: usize, const LIMBS: usize> Not for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const BITS: usize, const LIMBS: usize> Octal for Uint<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> Ord for Uint<BITS, LIMBS>

fn cmp(&self, rhs: &Self) -> 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<const BITS: usize, const LIMBS: usize> PartialEq<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn eq(&self, other: &Uint<BITS, LIMBS>) -> bool

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

fn ne(&self, other: &Uint<BITS, LIMBS>) -> bool

This method tests for !=.

impl<const BITS: usize, const LIMBS: usize> PartialOrd<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

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: &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<'a, const BITS: usize, const LIMBS: usize> Product<&'a Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = &'a Self>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<const BITS: usize, const LIMBS: usize> Product<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<const BITS: usize, const LIMBS: usize> Rem<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the % operation.

impl<const BITS: usize, const LIMBS: usize> Rem<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the % operation.

impl<const BITS: usize, const LIMBS: usize> Rem<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the % operation.

impl<const BITS: usize, const LIMBS: usize> Rem<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the % operation.

impl<const BITS: usize, const LIMBS: usize> RemAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn rem_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the %= operation.

impl<const BITS: usize, const LIMBS: usize> RemAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn rem_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the %= operation.

impl<const BITS: usize, const LIMBS: usize> Serialize for Uint<BITS, LIMBS>

Serialize a Uint value.

For human readable formats a 0x prefixed lower case hex string is used. For binary formats a byte array is used. Leading zeros are included.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<const BITS: usize, const LIMBS: usize> Shl<&'_ usize> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the << operator.

fn shl(self, rhs: &usize) -> Self

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> Shl<&'_ usize> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> Shl<usize> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> Shl<usize> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> ShlAssign<&'_ usize> for Uint<BITS, LIMBS>

fn shl_assign(&mut self, rhs: &usize)

Performs the <<= operation.

impl<const BITS: usize, const LIMBS: usize> ShlAssign<usize> for Uint<BITS, LIMBS>

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl<const BITS: usize, const LIMBS: usize> Shr<&'_ usize> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the >> operator.

fn shr(self, rhs: &usize) -> Self

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> Shr<&'_ usize> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> Shr<usize> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> Shr<usize> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> ShrAssign<&'_ usize> for Uint<BITS, LIMBS>

fn shr_assign(&mut self, rhs: &usize)

Performs the >>= operation.

impl<const BITS: usize, const LIMBS: usize> ShrAssign<usize> for Uint<BITS, LIMBS>

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<const BITS: usize, const LIMBS: usize> Sub<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the - operator.

fn sub(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the - operation.

impl<const BITS: usize, const LIMBS: usize> Sub<&'_ Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the - operator.

fn sub(self, rhs: &Uint<BITS, LIMBS>) -> Self::Output

Performs the - operation.

impl<const BITS: usize, const LIMBS: usize> Sub<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the - operator.

fn sub(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the - operation.

impl<const BITS: usize, const LIMBS: usize> Sub<Uint<BITS, LIMBS>> for &Uint<BITS, LIMBS>

type Output = Uint<BITS, LIMBS>

The resulting type after applying the - operator.

fn sub(self, rhs: Uint<BITS, LIMBS>) -> Self::Output

Performs the - operation.

impl<const BITS: usize, const LIMBS: usize> SubAssign<&'_ Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn sub_assign(&mut self, rhs: &Uint<BITS, LIMBS>)

Performs the -= operation.

impl<const BITS: usize, const LIMBS: usize> SubAssign<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn sub_assign(&mut self, rhs: Uint<BITS, LIMBS>)

Performs the -= operation.

impl<'a, const BITS: usize, const LIMBS: usize> Sum<&'a Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = &'a Self>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<const BITS: usize, const LIMBS: usize> Sum<Uint<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<const BITS: usize, const LIMBS: usize> ToSql for Uint<BITS, LIMBS>

Convert to Postgres types.

Compatible Postgres data types are:

• BOOL, SMALLINT, INTEGER, BIGINT which are 1, 16, 32 and 64 bit signed integers respectively.
• OID which is a 32 bit unsigned integer.
• FLOAT, DOUBLE PRECISION which are 32 and 64 bit floating point.
• DECIMAL and NUMERIC, which are variable length.
• MONEY which is a 64 bit integer with two decimals.
• BYTEA, BIT, VARBIT interpreted as a big-endian binary number.
• CHAR, VARCHAR, TEXT as 0x-prefixed big-endian hex strings.
• JSON, JSONB as a hex string compatible with the Serde serialization.

Note: Uints are never null, use Option<Uint> instead.

Errors

Returns an error when trying to convert to a value that is too small to fit the number. Note that this depends on the value, not the type, so a Uint<256> can be stored in a SMALLINT column, as long as the values are less than $2^{16}$.

Implementation details

The Postgres binary formats are used in the wire-protocol and the the COPY BINARY command, but they have very little documentation. You are pointed to the source code, for example this is the implementation of the the NUMERIC type serializer: numeric.c.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql(
    &self,
    ty: &Type,
    out: &mut BytesMut
) -> Result<IsNull, Box<dyn Error + Sync + Send + 'static>>

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn to_sql_checked(
    &self,
    ty: &Type,
    out: &mut BytesMut
) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ BigInt> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ BigUint> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<P: Fp256Parameters> TryFrom<&'_ Uint<256_usize, 4_usize>> for Fp256<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<256, 4>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp320Parameters> TryFrom<&'_ Uint<320_usize, 5_usize>> for Fp320<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<320, 5>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp384Parameters> TryFrom<&'_ Uint<384_usize, 6_usize>> for Fp384<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<384, 6>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp448Parameters> TryFrom<&'_ Uint<448_usize, 7_usize>> for Fp448<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<448, 7>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp64Parameters> TryFrom<&'_ Uint<64_usize, 1_usize>> for Fp64<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<64, 1>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp768Parameters> TryFrom<&'_ Uint<768_usize, 12_usize>> for Fp768<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<768, 12>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp832Parameters> TryFrom<&'_ Uint<832_usize, 13_usize>> for Fp832<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: &Uint<832, 13>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for bool

type Error = FromUintError<BITS, bool>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for i8

type Error = FromUintError<BITS, i8>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for u128

type Error = FromUintError<BITS, u128>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for u8

type Error = FromUintError<BITS, u8>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for i16

type Error = FromUintError<BITS, i16>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for u16

type Error = FromUintError<BITS, u16>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for i32

type Error = FromUintError<BITS, i32>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for u32

type Error = FromUintError<BITS, u32>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for i64

type Error = FromUintError<BITS, i64>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for u64

type Error = FromUintError<BITS, u64>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<&'_ Uint<BITS, LIMBS>> for i128

type Error = FromUintError<BITS, i128>

The type returned in the event of a conversion error.

fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<BigInt> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<BigUint> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<P: Fp256Parameters> TryFrom<Uint<256_usize, 4_usize>> for Fp256<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<256, 4>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp320Parameters> TryFrom<Uint<320_usize, 5_usize>> for Fp320<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<320, 5>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp384Parameters> TryFrom<Uint<384_usize, 6_usize>> for Fp384<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<384, 6>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp448Parameters> TryFrom<Uint<448_usize, 7_usize>> for Fp448<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<448, 7>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp64Parameters> TryFrom<Uint<64_usize, 1_usize>> for Fp64<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<64, 1>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp768Parameters> TryFrom<Uint<768_usize, 12_usize>> for Fp768<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<768, 12>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<P: Fp832Parameters> TryFrom<Uint<832_usize, 13_usize>> for Fp832<P>

type Error = ToFieldError

The type returned in the event of a conversion error.

fn try_from(value: Uint<832, 13>) -> Result<Self, ToFieldError>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for bool

type Error = FromUintError<BITS, bool>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for i8

type Error = FromUintError<BITS, i8>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for u128

type Error = FromUintError<BITS, u128>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for u8

type Error = FromUintError<BITS, u8>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for i16

type Error = FromUintError<BITS, i16>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for u16

type Error = FromUintError<BITS, u16>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for i32

type Error = FromUintError<BITS, i32>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for u32

type Error = FromUintError<BITS, u32>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for i64

type Error = FromUintError<BITS, i64>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for u64

type Error = FromUintError<BITS, u64>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>> for i128

type Error = FromUintError<BITS, i128>

The type returned in the event of a conversion error.

fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<f32> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<f64> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<i128> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<i16> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<i32> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<i64> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<i8> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<isize> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<u128> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<u16> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<u32> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<u64> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<u8> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize> TryFrom<usize> for Uint<BITS, LIMBS>

type Error = ToUintError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const BITS: usize, const LIMBS: usize, DB: Database> Type<DB> for Uint<BITS, LIMBS> where
    Vec<u8>: Type<DB>, 

fn type_info() -> DB::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &DB::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl<const BITS: usize, const LIMBS: usize> UpperHex for Uint<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> Copy for Uint<BITS, LIMBS>

impl<const BITS: usize, const LIMBS: usize> Eq for Uint<BITS, LIMBS>

impl<const BITS: usize, const LIMBS: usize> StructuralEq for Uint<BITS, LIMBS>

impl<const BITS: usize, const LIMBS: usize> StructuralPartialEq for Uint<BITS, LIMBS>