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 and rhs are < p.

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 bits(self) -> usize

Calculate the number of bits needed to represent this number.

impl<const LIMBS: usize> UInt<LIMBS>

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

Computes self / rhs, returns the quotient, remainder if rhs != 0

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

Computes self % rhs, returns the remainder if rhs != 0

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.

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.

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

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_uint_array(arr: [LimbUInt; LIMBS]) -> Self

Create a UInt from an array of the LimbUInt unsigned integer type.

pub const fn to_uint_array(self) -> [LimbUInt; LIMBS]

Create an array of LimbUInt unsigned integers from a UInt.

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>::Output

where Self: Concat,

Square self, returning a “wide” result.

impl<const LIMBS: usize> UInt<LIMBS>

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

Computes -a mod p in constant time.

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.

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.

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 and rhs are < 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 fn new(limbs: [Limb; LIMBS]) -> Self

Const-friendly UInt constructor.

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

Borrow the limbs of this UInt.

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

Convert this UInt into its inner limbs.

Trait Implementations

impl AddMod for UInt<1>

type Output = UInt<1>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<10>

type Output = UInt<10>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<11>

type Output = UInt<11>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<12>

type Output = UInt<12>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<2>

type Output = UInt<2>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<3>

type Output = UInt<3>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<4>

type Output = UInt<4>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<5>

type Output = UInt<5>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<6>

type Output = UInt<6>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<7>

type Output = UInt<7>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<8>

type Output = UInt<8>

Output type.

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

Compute self + rhs mod p.

impl AddMod for UInt<9>

type Output = UInt<9>

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> 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> 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 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 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 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 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 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 for UInt<LIMBS>

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

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<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.

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> Default for UInt<LIMBS>

fn default() -> Self

Returns the “default value” for a type.

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<UInt<LIMBS>>> for &UInt<LIMBS>

where UInt<LIMBS>: Integer,

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>

where UInt<LIMBS>: Integer,

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>

where UInt<LIMBS>: Integer,

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>

where UInt<LIMBS>: Integer,

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<UInt<LIMBS>>> for UInt<LIMBS>

where UInt<LIMBS>: Integer,

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

Performs the /= operation.

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

where UInt<LIMBS>: Integer,

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

Performs the /= operation.

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: [LimbUInt; LIMBS]) -> Self

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: (U64, U64)) -> 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: (U896, U896)) -> 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: (U128, U128)) -> 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: (U3072, U3072)) -> 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: (U1792, U1792)) -> 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: (U1024, U1024)) -> 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: (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<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: U8192) -> (UInt<{ _ }>, UInt<{ _ }>)

Converts to this type from the input type.

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

fn from(num: U192) -> (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: U128) -> (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: U2048) -> (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: U1536) -> (UInt<{ _ }>, UInt<{ _ }>)

Converts to this type from the input type.

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

fn from(num: U448) -> (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: U3072) -> (UInt<{ _ }>, UInt<{ _ }>)

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: U4096) -> (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: U3584) -> (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: U896) -> (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

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 [LimbUInt; LIMBS]

fn from(n: UInt<LIMBS>) -> [LimbUInt; 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.

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 NegMod for UInt<1>

type Output = UInt<1>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<10>

type Output = UInt<10>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<11>

type Output = UInt<11>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<12>

type Output = UInt<12>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<2>

type Output = UInt<2>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<3>

type Output = UInt<3>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<4>

type Output = UInt<4>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<5>

type Output = UInt<5>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<6>

type Output = UInt<6>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<7>

type Output = UInt<7>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<8>

type Output = UInt<8>

Output type.

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

Compute -self mod p.

impl NegMod for UInt<9>

type Output = UInt<9>

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) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<const LIMBS: usize> PartialEq 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 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> Rem<&NonZero<UInt<LIMBS>>> for &UInt<LIMBS>

where UInt<LIMBS>: Integer,

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>

where UInt<LIMBS>: Integer,

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>

where UInt<LIMBS>: Integer,

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>

where UInt<LIMBS>: Integer,

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<UInt<LIMBS>>> for UInt<LIMBS>

where UInt<LIMBS>: Integer,

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

Performs the %= operation.

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

where UInt<LIMBS>: Integer,

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

Performs the %= operation.

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 SubMod for UInt<1>

type Output = UInt<1>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<10>

type Output = UInt<10>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<11>

type Output = UInt<11>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<12>

type Output = UInt<12>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<2>

type Output = UInt<2>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<3>

type Output = UInt<3>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<4>

type Output = UInt<4>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<5>

type Output = UInt<5>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<6>

type Output = UInt<6>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<7>

type Output = UInt<7>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<8>

type Output = UInt<8>

Output type.

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

Compute self - rhs mod p.

impl SubMod for UInt<9>

type Output = UInt<9>

Output type.

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

Compute self - rhs mod p.

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> Eq for UInt<LIMBS>