Struct crypto_bigint::Uint

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

Big unsigned integer.

Generic over the given number of LIMBS

Encoding support

This type supports many different types of encodings, either via the Encoding trait or various const fn decoding and encoding functions that can be used with Uint constants.

Optional crate features for encoding (off-by-default):

• generic-array: enables ArrayEncoding trait which can be used to Uint as GenericArray<u8, N> and a ArrayDecoding trait which can be used to GenericArray<u8, N> as Uint.
• rlp: support for Recursive Length Prefix (RLP) encoding.

Implementations

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn adc(&self, rhs: &Self, carry: Limb) -> (Self, Limb)

Computes a + b + carry, returning the result along with the new carry.

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

Perform saturating addition, returning MAX on overflow.

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

Perform wrapping addition, discarding overflow.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn add_mod(&self, rhs: &Uint<LIMBS>, p: &Uint<LIMBS>) -> Uint<LIMBS>

Computes self + rhs mod p in constant time.

Assumes self + rhs as unbounded integer is < 2p.

pub const fn add_mod_special(&self, rhs: &Self, c: Limb) -> Self

Computes self + rhs mod p in constant time for the special modulus p = MAX+1-c where c is small enough to fit in a single Limb.

Assumes self + rhs as unbounded integer is < 2p.

impl<const LIMBS: usize> Uint<LIMBS>

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

Computes bitwise a & b.

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

Perform wrapping bitwise AND.

There’s no way wrapping could ever happen. This function exists so that all operations are accounted for in the wrapping operations

pub fn checked_and(&self, rhs: &Self) -> CtOption<Self>

Perform checked bitwise AND, returning a CtOption which is_some always

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn not(&self) -> Self

Computes bitwise !a.

impl<const LIMBS: usize> Uint<LIMBS>

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

Computes bitwise a & b.

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

Perform wrapping bitwise OR.

There’s no way wrapping could ever happen. This function exists so that all operations are accounted for in the wrapping operations

pub fn checked_or(&self, rhs: &Self) -> CtOption<Self>

Perform checked bitwise OR, returning a CtOption which is_some always

impl<const LIMBS: usize> Uint<LIMBS>

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

Computes bitwise a ^ b.

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

Perform wrapping bitwise `XOR``.

There’s no way wrapping could ever happen. This function exists so that all operations are accounted for in the wrapping operations

pub fn checked_xor(&self, rhs: &Self) -> CtOption<Self>

Perform checked bitwise XOR, returning a CtOption which is_some always

impl<const LIMBS: usize> Uint<LIMBS>

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

Returns true if the bit at position index is set, false otherwise.

pub const fn bits_vartime(self) -> usize

Calculate the number of bits needed to represent this number.

pub const fn leading_zeros(self) -> usize

Calculate the number of leading zeros in the binary representation of this number.

pub const fn trailing_zeros(self) -> usize

Calculate the number of trailing zeros in the binary representation of this number.

pub const fn bits(self) -> usize

Calculate the number of bits needed to represent this number.

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

Get the value of the bit at position index, as a truthy or falsy CtChoice. Returns the falsy value for indices out of range.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn ct_div_rem_limb_with_reciprocal( &self, reciprocal: &Reciprocal ) -> (Self, Limb)

Computes self / rhs using a pre-made reciprocal, returns the quotient (q) and remainder (r).

pub fn div_rem_limb_with_reciprocal( &self, reciprocal: &CtOption<Reciprocal> ) -> CtOption<(Self, Limb)>

Computes self / rhs using a pre-made reciprocal, returns the quotient (q) and remainder (r).

pub fn div_rem_limb(&self, rhs: NonZero<Limb>) -> (Self, Limb)

Computes self / rhs, returns the quotient (q) and remainder (r).

pub const fn const_rem(&self, rhs: &Self) -> (Self, CtChoice)

Computes self % rhs, returns the remainder and and the truthy value for is_some or the falsy value for is_none.

NOTE: Use only if you need to access const fn. Otherwise use Self::rem. This is variable only with respect to rhs.

When used with a fixed rhs, this function is constant-time with respect to self.

pub const fn const_rem_wide( lower_upper: (Self, Self), rhs: &Self ) -> (Self, CtChoice)

Computes self % rhs, returns the remainder and and the truthy value for is_some or the falsy value for is_none.

This is variable only with respect to rhs.

When used with a fixed rhs, this function is constant-time with respect to self.

pub const fn rem2k(&self, k: usize) -> Self

Computes self % 2^k. Faster than reduce since its a power of 2. Limited to 2^16-1 since Uint doesn’t support higher.

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

Computes self / rhs, returns the quotient, remainder.

pub fn rem(&self, rhs: &NonZero<Self>) -> Self

Computes self % rhs, returns the remainder.

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

Wrapped division is just normal division i.e. self / rhs There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

Panics if rhs == 0.

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

Perform checked division, returning a CtOption which is_some only if the rhs != 0

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

Wrapped (modular) remainder calculation is just self % rhs. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

Panics if rhs == 0.

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

Perform checked reduction, returning a CtOption which is_some only if the rhs != 0

impl<const LIMBS: usize> Uint<LIMBS>

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

Create a new Uint from the provided big endian bytes.

pub const fn from_be_hex(hex: &str) -> Self

Create a new Uint from the provided big endian hex string.

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

Create a new Uint from the provided little endian bytes.

pub const fn from_le_hex(hex: &str) -> Self

Create a new Uint from the provided little endian hex string.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn from_u8(n: u8) -> Self

Create a Uint from a u8 (const-friendly)

pub const fn from_u16(n: u16) -> Self

Create a Uint from a u16 (const-friendly)

pub const fn from_u32(n: u32) -> Self

Create a Uint from a u32 (const-friendly)

pub const fn from_u64(n: u64) -> Self

Available on 64-bit only.

Create a Uint from a u64 (const-friendly)

pub const fn from_u128(n: u128) -> Self

Create a Uint from a u128 (const-friendly)

pub const fn from_word(n: Word) -> Self

Create a Uint from a Word (const-friendly)

pub const fn from_wide_word(n: WideWord) -> Self

Create a Uint from a WideWord (const-friendly)

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn inv_mod2k(&self, k: usize) -> Self

Computes 1/self mod 2^k as specified in Algorithm 4 from A Secure Algorithm for Inversion Modulo 2k by Sadiel de la Fe and Carles Ferrer. See https://www.mdpi.com/2410-387X/2/3/23.

Conditions: self < 2^k and self must be odd

pub const fn inv_odd_mod_bounded( &self, modulus: &Self, bits: usize, modulus_bits: usize ) -> (Self, CtChoice)

Computes the multiplicative inverse of self mod modulus, where modulus is odd. In other words self^-1 mod modulus. bits and modulus_bits are the bounds on the bit size of self and modulus, respectively (the inversion speed will be proportional to bits + modulus_bits). The second element of the tuple is the truthy value if an inverse exists, otherwise it is a falsy value.

Note: variable time in bits and modulus_bits.

The algorithm is the same as in GMP 6.2.1’s mpn_sec_invert.

pub const fn inv_odd_mod(&self, modulus: &Self) -> (Self, CtChoice)

Computes the multiplicative inverse of self mod modulus, where modulus is odd. Returns (inverse, Word::MAX) if an inverse exists, otherwise (undefined, Word::ZERO).

impl<const LIMBS: usize> Uint<LIMBS>

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

Compute “wide” multiplication, with a product twice the size of the input.

Returns a tuple containing the (lo, hi) components of the product.

Ordering note

Releases of crypto-bigint prior to v0.3 used (hi, lo) ordering instead. This has been changed for better consistency with the rest of the APIs in this crate.

For more info see: https://github.com/RustCrypto/crypto-bigint/issues/4

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

Perform saturating multiplication, returning MAX on overflow.

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

Perform wrapping multiplication, discarding overflow.

pub fn square(&self) -> <Self as Concat>::Outputwhere Self: Concat,

Square self, returning a concatenated “wide” result.

pub const fn square_wide(&self) -> (Self, Self)

Square self, returning a “wide” result in two parts as (lo, hi).

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn mul_mod_special(&self, rhs: &Self, c: Limb) -> Self

Computes self * rhs mod p in constant time for the special modulus p = MAX+1-c where c is small enough to fit in a single Limb. For the modulus reduction, this function implements Algorithm 14.47 from the “Handbook of Applied Cryptography”, by A. Menezes, P. van Oorschot, and S. Vanstone, CRC Press, 1996.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn neg_mod(&self, p: &Self) -> Self

Computes -a mod p in constant time. Assumes self is in [0, p).

pub const fn neg_mod_special(&self, c: Limb) -> Self

Computes -a mod p in constant time for the special modulus p = MAX+1-c where c is small enough to fit in a single Limb.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn resize<const T: usize>(&self) -> Uint<T>

Construct a Uint<T> from the unsigned integer value, truncating the upper bits if the value is too large to be represented.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn shl_vartime(&self, n: usize) -> Self

Computes self << shift.

NOTE: this operation is variable time with respect to n ONLY.

When used with a fixed n, this function is constant-time with respect to self.

pub const fn shl_vartime_wide( lower_upper: (Self, Self), n: usize ) -> (Self, Self)

Computes a left shift on a wide input as (lo, hi).

NOTE: this operation is variable time with respect to n ONLY.

When used with a fixed n, this function is constant-time with respect to self.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn shr_vartime(&self, shift: usize) -> Self

Computes self >> n.

NOTE: this operation is variable time with respect to n ONLY.

When used with a fixed n, this function is constant-time with respect to self.

pub const fn shr_vartime_wide( lower_upper: (Self, Self), n: usize ) -> (Self, Self)

Computes a right shift on a wide input as (lo, hi).

NOTE: this operation is variable time with respect to n ONLY.

When used with a fixed n, this function is constant-time with respect to self.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn sqrt(&self) -> Self

Computes √(self) Uses Brent & Zimmermann, Modern Computer Arithmetic, v0.5.9, Algorithm 1.13

Callers can check if self is a square by squaring the result

pub const fn wrapping_sqrt(&self) -> Self

Wrapped sqrt is just normal √(self) There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

pub fn checked_sqrt(&self) -> CtOption<Self>

Perform checked sqrt, returning a CtOption which is_some only if the √(self)² == self

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn sbb(&self, rhs: &Self, borrow: Limb) -> (Self, Limb)

Computes a - (b + borrow), returning the result along with the new borrow.

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

Perform saturating subtraction, returning ZERO on underflow.

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

Perform wrapping subtraction, discarding underflow and wrapping around the boundary of the type.

impl<const LIMBS: usize> Uint<LIMBS>

pub const fn sub_mod(&self, rhs: &Uint<LIMBS>, p: &Uint<LIMBS>) -> Uint<LIMBS>

Computes self - rhs mod p in constant time.

Assumes self - rhs as unbounded signed integer is in [-p, p).

pub const fn sub_mod_special(&self, rhs: &Self, c: Limb) -> Self

Computes self - rhs mod p in constant time for the special modulus p = MAX+1-c where c is small enough to fit in a single Limb.

Assumes self - rhs as unbounded signed integer is in [-p, p).

impl<const LIMBS: usize> Uint<LIMBS>

pub const ZERO: Self = _

The value 0.

pub const ONE: Self = _

The value 1.

pub const MAX: Self = _

Maximum value this Uint can express.

pub const BITS: usize = _

Total size of the represented integer in bits.

pub const BYTES: usize = _

Total size of the represented integer in bytes.

pub const LIMBS: usize = LIMBS

The number of limbs used on this platform.

pub const fn new(limbs: [Limb; LIMBS]) -> Self

Const-friendly Uint constructor.

pub const fn from_words(arr: [Word; LIMBS]) -> Self

Create a Uint from an array of Words (i.e. word-sized unsigned integers).

pub const fn to_words(self) -> [Word; LIMBS]

Create an array of Words (i.e. word-sized unsigned integers) from a Uint.

pub const fn as_words(&self) -> &[Word; LIMBS]

Borrow the inner limbs as an array of Words.

pub fn as_words_mut(&mut self) -> &mut [Word; LIMBS]

Borrow the inner limbs as a mutable array of Words.

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

Borrow the limbs of this Uint.

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

Borrow the limbs of this Uint mutably.

pub const fn to_limbs(self) -> [Limb; LIMBS]

Convert this Uint into its inner limbs.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn concat(&self, rhs: &Self) -> Uint<{ _ }>

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

impl Uint<{nlimbs!($bits)}>

pub const fn split(&self) -> (Uint<{ _ }>, Uint<{ _ }>)

Split this number in half, returning its high and low components respectively.

Trait Implementations

impl<const LIMBS: usize> AddMod<Uint<LIMBS>> for Uint<LIMBS>

type Output = Uint<LIMBS>

Output type.

fn add_mod(&self, rhs: &Self, p: &Self) -> Self

Compute self + rhs mod p.

impl<const LIMBS: usize> AsMut<[Limb]> for Uint<LIMBS>

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

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

impl<const LIMBS: usize> AsMut<[u64; LIMBS]> for Uint<LIMBS>

fn as_mut(&mut self) -> &mut [Word; LIMBS]

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

impl<const LIMBS: usize> AsRef<[Limb]> for Uint<LIMBS>

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

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

impl<const LIMBS: usize> AsRef<[u64; LIMBS]> for Uint<LIMBS>

fn as_ref(&self) -> &[Word; LIMBS]

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

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

type Output = Uint<LIMBS>

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const LIMBS: usize> BitAndAssign<&Uint<LIMBS>> for Uint<LIMBS>

fn bitand_assign(&mut self, other: &Self)

Performs the &= operation.

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

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const LIMBS: usize> BitOrAssign<&Uint<LIMBS>> for Uint<LIMBS>

fn bitor_assign(&mut self, other: &Self)

Performs the |= operation.

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

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

type Output = Uint<LIMBS>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const LIMBS: usize> BitXorAssign<&Uint<LIMBS>> for Uint<LIMBS>

fn bitxor_assign(&mut self, other: &Self)

Performs the ^= operation.

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

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl<const LIMBS: usize> Bounded for Uint<LIMBS>

const BITS: usize = Self::BITS

Size of this integer in bits.

const BYTES: usize = Self::BYTES

Size of this integer in bytes.

impl<const LIMBS: usize> CheckedAdd<&Uint<LIMBS>> for Uint<LIMBS>

type Output = Uint<LIMBS>

Output type.

fn checked_add(&self, rhs: &Self) -> CtOption<Self>

Perform checked subtraction, returning a CtOption which is_some only if the operation did not overflow.

impl<const LIMBS: usize> CheckedMul<&Uint<LIMBS>> for Uint<LIMBS>

type Output = Uint<LIMBS>

Output type.

fn checked_mul(&self, rhs: &Self) -> CtOption<Self>

Perform checked multiplication, returning a CtOption which is_some only if the operation did not overflow.

impl<const LIMBS: usize> CheckedSub<&Uint<LIMBS>> for Uint<LIMBS>

type Output = Uint<LIMBS>

Output type.

fn checked_sub(&self, rhs: &Self) -> CtOption<Self>

Perform checked subtraction, returning a CtOption which is_some only if the operation did not underflow.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Concat<Uint<{nlimbs!($bits)}>> for U1024

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U128

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U1536

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U1792

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U192

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U2048

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U256

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U3072

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U320

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U384

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U4096

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U448

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U512

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U64

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U640

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U768

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl Concat<Uint<{nlimbs!($bits)}>> for U896

type Output = Uint<{nlimbs!($bits) * 2}>

Concatenated output: twice the width of Self.

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

Concatenate the two values, with self as most significant and rhs as the least significant.

impl<const LIMBS: usize> ConditionallySelectable for Uint<LIMBS>

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl<const LIMBS: usize> ConstantTimeEq for Uint<LIMBS>

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl<const LIMBS: usize> ConstantTimeGreater for Uint<LIMBS>

fn ct_gt(&self, other: &Self) -> Choice

Determine whether self > other.

impl<const LIMBS: usize> ConstantTimeLess for Uint<LIMBS>

fn ct_lt(&self, other: &Self) -> Choice

Determine whether self < other.

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

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

Formats the value using the given formatter.

impl<const LIMBS: usize> Decodable for Uint<LIMBS>where Self: Encoding, <Self as Encoding>::Repr: Default,

Available on crate feature rlp only.

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

Decode a value from RLP bytes

impl<'a, const LIMBS: usize> DecodeValue<'a> for Uint<LIMBS>where Uint<LIMBS>: ArrayEncoding,

Available on crate features der and generic-array only.

fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self>

Attempt to decode this message using the provided Reader.

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

fn default() -> Self

Returns the “default value” for a type.

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

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

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

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

Formats the value using the given formatter.

impl<const LIMBS: usize> Div<&NonZero<Limb>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Limb>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Limb>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Limb>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const LIMBS: usize> DivAssign<&NonZero<Limb>> for Uint<LIMBS>

fn div_assign(&mut self, rhs: &NonZero<Limb>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

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

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<Limb>> for Uint<LIMBS>

fn div_assign(&mut self, rhs: NonZero<Limb>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

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

Performs the /= operation.

impl<const LIMBS: usize> Encodable for Uint<LIMBS>where Self: Encoding,

Available on crate feature rlp only.

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

Append a value to the stream

fn rlp_bytes(&self) -> BytesMut

Get rlp-encoded bytes for this instance

impl<const LIMBS: usize> EncodeValue for Uint<LIMBS>where Uint<LIMBS>: ArrayEncoding,

Available on crate features der and generic-array only.

fn value_len(&self) -> Result<Length>

Compute the length of this value (sans [Tag]+Length header) when encoded as ASN.1 DER.

fn encode_value(&self, encoder: &mut impl Writer) -> Result<()>

Encode value (sans [Tag]+Length header) as ASN.1 DER using the provided Writer.

fn header(&self) -> Result<Header, Error>where Self: Tagged,

Get the Header used to encode this value.

impl<const LIMBS: usize> FixedTag for Uint<LIMBS>where Uint<LIMBS>: ArrayEncoding,

Available on crate features der and generic-array only.

const TAG: Tag = Tag::Integer

ASN.1 tag

impl<const LIMBS: usize> From<[Limb; LIMBS]> for Uint<LIMBS>

fn from(limbs: [Limb; LIMBS]) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<[u64; LIMBS]> for Uint<LIMBS>

fn from(arr: [Word; LIMBS]) -> Self

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U896, U896)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U768, U768)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U4096, U4096)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U320, U320)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U1536, U1536)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U512, U512)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U256, U256)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U1792, U1792)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U128, U128)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U448, U448)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U192, U192)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U64, U64)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U2048, U2048)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U384, U384)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U1024, U1024)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U640, U640)) -> Uint<{ _ }>

Converts to this type from the input type.

impl From<(Uint<{nlimbs!($bits)}>, Uint<{nlimbs!($bits)}>)> for Uint<{ _ }>

fn from(nums: (U3072, U3072)) -> Uint<{ _ }>

Converts to this type from the input type.

impl<const LIMBS: usize> From<Limb> for Uint<LIMBS>

fn from(limb: Limb) -> Self

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U6144) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U128) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U1024) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U896) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U768) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U384) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U640) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U512) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U2048) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U3584) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U4096) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U8192) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U1792) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U256) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U1536) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U1280) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for (Uint<{ _ }>, Uint<{ _ }>)

fn from(num: U3072) -> (Uint<{ _ }>, Uint<{ _ }>)

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for u128

fn from(n: U128) -> u128

Converts to this type from the input type.

impl From<Uint<{nlimbs!($bits)}>> for u64

Available on 64-bit only.

fn from(n: U64) -> u64

Converts to this type from the input type.

impl<const LIMBS: usize> From<Uint<LIMBS>> for [Limb; LIMBS]

fn from(n: Uint<LIMBS>) -> [Limb; LIMBS]

Converts to this type from the input type.

impl<const LIMBS: usize> From<Uint<LIMBS>> for [Word; LIMBS]

fn from(n: Uint<LIMBS>) -> [Word; LIMBS]

Converts to this type from the input type.

impl<const LIMBS: usize> From<u128> for Uint<LIMBS>

fn from(n: u128) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<u16> for Uint<LIMBS>

fn from(n: u16) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<u32> for Uint<LIMBS>

fn from(n: u32) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<u64> for Uint<LIMBS>

fn from(n: u64) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<u8> for Uint<LIMBS>

fn from(n: u8) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> Hash for Uint<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const LIMBS: usize> Integer for Uint<LIMBS>

const ONE: Self = Self::ONE

The value 1.

const MAX: Self = Self::MAX

Maximum value this integer can express.

const BITS: usize = Self::BITS

Total size of the represented integer in bits.

const BYTES: usize = Self::BYTES

Total size of the represented integer in bytes.

const LIMBS: usize = Self::LIMBS

The number of limbs used on this platform.

fn is_odd(&self) -> Choice

Is this integer value an odd number?

fn is_even(&self) -> Choice

Is this integer value an even number?

impl<const LIMBS: usize> LowerHex for Uint<LIMBS>

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

Formats the value using the given formatter.

impl<const LIMBS: usize> NegMod for Uint<LIMBS>

type Output = Uint<LIMBS>

Output type.

fn neg_mod(&self, p: &Self) -> Self

Compute -self mod p.

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

type Output = Uint<LIMBS>

The resulting type after applying the ! operator.

fn not(self) -> <Self as Not>::Output

Performs the unary ! operation.

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<const LIMBS: usize> PartialEq<Uint<LIMBS>> for Uint<LIMBS>

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

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

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

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

impl<const LIMBS: usize> PartialOrd<Uint<LIMBS>> for Uint<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<const LIMBS: usize> PowBoundedExp<Uint<LIMBS>> for DynResidue<LIMBS>

fn pow_bounded_exp(&self, exponent: &Uint<LIMBS>, exponent_bits: usize) -> Self

Raises to the exponent power, with exponent_bits representing the number of (least significant) bits to take into account for the exponent.

impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> PowBoundedExp<Uint<LIMBS>> for Residue<MOD, LIMBS>

fn pow_bounded_exp(&self, exponent: &Uint<LIMBS>, exponent_bits: usize) -> Self

Raises to the exponent power, with exponent_bits representing the number of (least significant) bits to take into account for the exponent.

impl<const LIMBS: usize> Random for Uint<LIMBS>

Available on crate feature rand_core only.

fn random(rng: &mut impl CryptoRngCore) -> Self

Generate a cryptographically secure random Uint.

impl<const LIMBS: usize> RandomMod for Uint<LIMBS>

Available on crate feature rand_core only.

fn random_mod(rng: &mut impl CryptoRngCore, modulus: &NonZero<Self>) -> Self

Generate a cryptographically secure random Uint which is less than a given modulus.

This function uses rejection sampling, a method which produces an unbiased distribution of in-range values provided the underlying CSRNG is unbiased, but runs in variable-time.

The variable-time nature of the algorithm should not pose a security issue so long as the underlying random number generator is truly a CSRNG, where previous outputs are unrelated to subsequent outputs and do not reveal information about the RNG’s internal state.

impl<const LIMBS: usize> Rem<&NonZero<Limb>> for &Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Limb>> for Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Limb>> for &Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Limb>> for Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<const LIMBS: usize> RemAssign<&NonZero<Limb>> for Uint<LIMBS>

fn rem_assign(&mut self, rhs: &NonZero<Limb>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

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

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<Limb>> for Uint<LIMBS>

fn rem_assign(&mut self, rhs: NonZero<Limb>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

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

Performs the %= operation.

impl<const LIMBS: usize> Serialize for Uint<LIMBS>where Uint<LIMBS>: Encoding,

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

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

fn shl(self, rhs: usize) -> Uint<LIMBS>

NOTE: this operation is variable time with respect to rhs ONLY.

When used with a fixed rhs, this function is constant-time with respect to self.

type Output = Uint<LIMBS>

The resulting type after applying the << operator.

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

fn shl(self, rhs: usize) -> Uint<LIMBS>

NOTE: this operation is variable time with respect to rhs ONLY.

When used with a fixed rhs, this function is constant-time with respect to self.

type Output = Uint<LIMBS>

The resulting type after applying the << operator.

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

fn shl_assign(&mut self, rhs: usize)

NOTE: this operation is variable time with respect to rhs ONLY.

When used with a fixed rhs, this function is constant-time with respect to self.

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

fn shr(self, rhs: usize) -> Uint<LIMBS>

NOTE: this operation is variable time with respect to rhs ONLY.

When used with a fixed rhs, this function is constant-time with respect to self.

type Output = Uint<LIMBS>

The resulting type after applying the >> operator.

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

fn shr(self, rhs: usize) -> Uint<LIMBS>

NOTE: this operation is variable time with respect to rhs ONLY.

When used with a fixed rhs, this function is constant-time with respect to self.

type Output = Uint<LIMBS>

The resulting type after applying the >> operator.

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

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Split<Uint<{nlimbs!($bits)}>> for U1024

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U128

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U1280

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U1536

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U1792

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U2048

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U256

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U3072

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U3584

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U384

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U4096

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U512

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U6144

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U640

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U768

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U8192

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl Split<Uint<{nlimbs!($bits)}>> for U896

type Output = Uint<{nlimbs!($bits) / 2}>

Split output: high/low components of the value.

fn split(&self) -> (Self::Output, Self::Output)

Split this number in half, returning its high and low components respectively.

impl<const LIMBS: usize> SubMod<Uint<LIMBS>> for Uint<LIMBS>

type Output = Uint<LIMBS>

Output type.

fn sub_mod(&self, rhs: &Self, p: &Self) -> Self

Compute self - rhs mod p.

impl<'a, const LIMBS: usize> TryFrom<AnyRef<'a>> for Uint<LIMBS>where Uint<LIMBS>: ArrayEncoding,

Available on crate features der and generic-array only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: AnyRef<'a>) -> Result<Uint<LIMBS>>

Performs the conversion.

impl<'a, const LIMBS: usize> TryFrom<UintRef<'a>> for Uint<LIMBS>where Uint<LIMBS>: ArrayEncoding,

Available on crate features der and generic-array only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: UintRef<'a>) -> Result<Uint<LIMBS>>

Performs the conversion.

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

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

Formats the value using the given formatter.

impl<const LIMBS: usize> Zero for Uint<LIMBS>

const ZERO: Self = Self::ZERO

The value 0.

fn is_zero(&self) -> Choice

Determine if this value is equal to zero.

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

impl<const LIMBS: usize> DefaultIsZeroes for Uint<LIMBS>

Available on crate feature zeroize only.

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