Struct BigInt 

pub struct BigInt { /* private fields */ }

Big integer

Wraps underlying BigInt implementation (either GMP bindings or num-bigint), exposes only very limited API that allows easily switching between implementations.

Set of traits implemented on BigInt remains the same regardless of underlying implementation.

Trait Implementations

impl Add<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&BigInt> for u64

type Output = BigInt

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: BigInt) -> Self::Output

Performs the + operation.

impl Add<BigInt> for u64

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: BigInt) -> Self::Output

Performs the + operation.

impl Add<u64> for &BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl Add<u64> for BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl Add for &BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add for BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<&BigInt> for BigInt

fn add_assign(&mut self, rhs: &BigInt)

Performs the += operation.

impl AddAssign<u64> for BigInt

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign for BigInt

fn add_assign(&mut self, rhs: BigInt)

Performs the += operation.

impl BasicOps for BigInt

fn pow(&self, exponent: u32) -> Self

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

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

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

fn abs(&self) -> Self

impl BitAnd<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the & operator.

fn bitand(self, rhs: BigInt) -> Self::Output

Performs the & operation.

impl BitAnd for &BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<&BigInt> for BigInt

fn bitand_assign(&mut self, rhs: &BigInt)

Performs the &= operation.

impl BitAndAssign for BigInt

fn bitand_assign(&mut self, rhs: BigInt)

Performs the &= operation.

impl BitManipulation for BigInt

fn set_bit(&mut self, bit: usize, bit_val: bool)

Sets/unsets bit in the number

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

Tests if bit is set

fn bit_length(&self) -> usize

Length of the number in bits

impl BitOrAssign<&BigInt> for BigInt

fn bitor_assign(&mut self, rhs: &BigInt)

Performs the |= operation.

impl BitOrAssign for BigInt

fn bitor_assign(&mut self, rhs: BigInt)

Performs the |= operation.

impl BitXor<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: BigInt) -> Self::Output

Performs the ^ operation.

impl BitXor for &BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<&BigInt> for BigInt

fn bitxor_assign(&mut self, rhs: &BigInt)

Performs the ^= operation.

impl BitXorAssign for BigInt

fn bitxor_assign(&mut self, rhs: BigInt)

Performs the ^= operation.

impl Clone for BigInt

fn clone(&self) -> BigInt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: Digest + Clone> Commitment<BigInt> for HashCommitment<H>

fn create_commitment_with_user_defined_randomness( message: &BigInt, blinding_factor: &BigInt, ) -> BigInt

fn create_commitment(message: &BigInt) -> (BigInt, BigInt)

impl ConvertFrom<BigInt> for u64

fn _from(x: &BigInt) -> u64

👎Deprecated since 0.6.0: Use corresponding From<T> and TryFrom<T> traits implemented on BigInt

impl Converter for BigInt

fn to_bytes(&self) -> Vec<u8>

Returns bytes representation of the number.

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

Constructs BigInt from its byte representation

fn to_hex(&self) -> String

Converts BigInt to hex representation.

fn from_hex(n: &str) -> Result<Self, ParseBigIntError>

Parses given hex string.

fn to_str_radix(&self, radix: u8) -> String

Converts BigInt to radix representation.

fn from_str_radix(str: &str, radix: u8) -> Result<Self, ParseBigIntError>

Parses given radix string.

fn to_bytes_array<const N: usize>(&self) -> Option<[u8; N]>

Returns bytes representation of the number in an array with length chosen by the user if the array is larger than the bytes it pads it with zeros in the most significant bytes If the array is too small for the integer it returns None.

impl Debug for BigInt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BigInt

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BigInt

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

Formats the value using the given formatter.

impl Div<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the / operator.

fn div(self, rhs: BigInt) -> Self::Output

Performs the / operation.

impl Div<u64> for &BigInt

type Output = BigInt

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl Div<u64> for BigInt

type Output = BigInt

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl Div for &BigInt

type Output = BigInt

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for BigInt

type Output = BigInt

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&BigInt> for BigInt

fn div_assign(&mut self, rhs: &BigInt)

Performs the /= operation.

impl DivAssign<u64> for BigInt

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl DivAssign for BigInt

fn div_assign(&mut self, rhs: BigInt)

Performs the /= operation.

impl EGCD for BigInt

fn egcd(a: &Self, b: &Self) -> (Self, Self, Self)

For given a, b calculates gcd(a,b), p, q such as gcd(a,b) = a*p + b*q

impl<E: Curve> From<&BigInt> for Scalar<E>

fn from(n: &BigInt) -> Self

Converts to this type from the input type.

impl<E: Curve> From<BigInt> for Scalar<E>

fn from(n: BigInt) -> Self

Converts to this type from the input type.

impl From<i32> for BigInt

fn from(x: i32) -> Self

Converts to this type from the input type.

impl From<u16> for BigInt

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for BigInt

fn from(x: u32) -> Self

Converts to this type from the input type.

impl From<u64> for BigInt

fn from(x: u64) -> Self

Converts to this type from the input type.

impl Integer for BigInt

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

Floored integer division.

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

Floored integer modulo, satisfying:

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

Ceiled integer division.

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

Greatest Common Divisor (GCD).

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

Lowest Common Multiple (LCM).

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

Greatest Common Divisor (GCD) and Lowest Common Multiple (LCM) together.

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

👎Deprecated: Please use is_multiple_of instead

Deprecated, use is_multiple_of instead.

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

Returns true if self is a multiple of other.

fn is_even(&self) -> bool

Returns true if the number is even.

fn is_odd(&self) -> bool

Returns true if the number is odd.

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

Simultaneous truncated integer division and modulus. Returns (quotient, remainder).

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

Simultaneous floored integer division and modulus. Returns (quotient, remainder).

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

where Self: Clone,

Rounds up to nearest multiple of argument.

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

where Self: Clone,

Rounds down to nearest multiple of argument.

fn extended_gcd(&self, other: &Self) -> ExtendedGcd<Self>

where Self: Clone,

Greatest common divisor and Bézout coefficients.

fn dec(&mut self)

where Self: Clone,

Decrements self by one.

fn inc(&mut self)

where Self: Clone,

Increments self by one.

impl Modulo for BigInt

fn mod_pow(base: &Self, exponent: &Self, modulus: &Self) -> Self

Calculates base^(exponent) (mod m)

fn mod_mul(a: &Self, b: &Self, modulus: &Self) -> Self

Calculates a * b (mod m)

fn mod_sub(a: &Self, b: &Self, modulus: &Self) -> Self

Calculates a - b (mod m)

fn mod_add(a: &Self, b: &Self, modulus: &Self) -> Self

Calculates a + b (mod m)

fn mod_inv(a: &Self, modulus: &Self) -> Option<Self>

Calculates a^-1 (mod m). Returns None if a and m are not coprimes.

fn modulus(&self, modulus: &Self) -> Self

Calculates a mod m

impl Mul<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&BigInt> for u64

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the * operator.

fn mul(self, rhs: BigInt) -> Self::Output

Performs the * operation.

impl Mul<BigInt> for u64

type Output = BigInt

The resulting type after applying the * operator.

fn mul(self, rhs: BigInt) -> Self::Output

Performs the * operation.

impl Mul<u64> for &BigInt

type Output = BigInt

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl Mul<u64> for BigInt

type Output = BigInt

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl Mul for &BigInt

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for BigInt

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&BigInt> for BigInt

fn mul_assign(&mut self, rhs: &BigInt)

Performs the *= operation.

impl MulAssign<u64> for BigInt

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl MulAssign for BigInt

fn mul_assign(&mut self, rhs: BigInt)

Performs the *= operation.

impl Neg for &BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Num for BigInt

type FromStrRadixErr = ParseBigIntError

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

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

impl NumberTests for BigInt

fn is_zero(n: &Self) -> bool

Returns true if n is zero

fn is_negative(n: &Self) -> bool

Returns true if n is negative

impl One for BigInt

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

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

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for BigInt

fn cmp(&self, other: &BigInt) -> 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,

Restrict a value to a certain interval.

impl PartialEq for BigInt

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for BigInt

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Primes for BigInt

fn next_prime(&self) -> BigInt

Finds next prime number using probabilistic algorithms

fn is_probable_prime(&self, n: u32) -> bool

Probabilistically determine whether number is prime

impl Rem<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the % operator.

fn rem(self, rhs: BigInt) -> Self::Output

Performs the % operation.

impl Rem<u64> for &BigInt

type Output = BigInt

The resulting type after applying the % operator.

fn rem(self, rhs: u64) -> Self::Output

Performs the % operation.

impl Rem<u64> for BigInt

type Output = BigInt

The resulting type after applying the % operator.

fn rem(self, rhs: u64) -> Self::Output

Performs the % operation.

impl Rem for &BigInt

type Output = BigInt

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for BigInt

type Output = BigInt

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<&BigInt> for BigInt

fn rem_assign(&mut self, rhs: &BigInt)

Performs the %= operation.

impl RemAssign<u64> for BigInt

fn rem_assign(&mut self, rhs: u64)

Performs the %= operation.

impl RemAssign for BigInt

fn rem_assign(&mut self, rhs: BigInt)

Performs the %= operation.

impl Roots for BigInt

fn nth_root(&self, n: u32) -> Self

Returns the truncated principal nth root of an integer – if x >= 0 { ⌊ⁿ√x⌋ } else { ⌈ⁿ√x⌉ }

fn sqrt(&self) -> Self

Returns the truncated principal square root of an integer – ⌊√x⌋

fn cbrt(&self) -> Self

Returns the truncated principal cube root of an integer – if x >= 0 { ⌊∛x⌋ } else { ⌈∛x⌉ }

impl Samplable for BigInt

fn sample_below(upper: &Self) -> Self

Generates random number within [0; upper) range

fn sample_range(lower: &Self, upper: &Self) -> Self

Generates random number within [lower; upper) range

fn strict_sample_range(lower: &Self, upper: &Self) -> Self

Generates random number within (lower; upper) range

fn sample(bit_size: usize) -> Self

Generates number within [0; 2^bit_size) range

fn strict_sample(bit_size: usize) -> Self

Generates number within [2^(bit_size-1); 2^bit_size) range

impl Serialize for BigInt

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<usize> for &BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<usize> for BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<usize> for BigInt

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for &BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<usize> for BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<usize> for BigInt

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<&BigInt> for BigInt

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&BigInt> for u64

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn sub(self, rhs: BigInt) -> Self::Output

Performs the - operation.

impl Sub<BigInt> for u64

type Output = BigInt

The resulting type after applying the - operator.

fn sub(self, rhs: BigInt) -> Self::Output

Performs the - operation.

impl Sub<u64> for &BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl Sub<u64> for BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl Sub for &BigInt

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for BigInt

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&BigInt> for BigInt

fn sub_assign(&mut self, rhs: &BigInt)

Performs the -= operation.

impl SubAssign<u64> for BigInt

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl SubAssign for BigInt

fn sub_assign(&mut self, rhs: BigInt)

Performs the -= operation.

impl TryFrom<&BigInt> for i64

type Error = TryFromBigIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&BigInt> for u64

type Error = TryFromBigIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zero for BigInt

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

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

impl Zeroize for BigInt

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl ZeroizeBN for BigInt

fn zeroize_bn(&mut self)

👎Deprecated since 0.6.0: BigInt now implements zeroize::Zeroize trait, you should use it instead

impl Eq for BigInt

impl StructuralPartialEq for BigInt