Struct soroban_sdk::BigInt

#[repr(transparent)]
pub struct BigInt(_);

BigInt is an arbitrary sized signed integer.

Examples

use soroban_sdk::{BigInt, Env};

let env = Env::default();
let b1 = BigInt::from_u64(&env, u64::MAX);
let b2 = b1 * 3;
let b3 = b2 / 4;
assert_eq!(b3, 13_835_058_055_282_163_711u64)

Implementations

impl BigInt

pub fn zero(env: &Env) -> BigInt

Creates a BigInt with the value zero.

pub fn from_u64(env: &Env, u: u64) -> BigInt

Creates a BigInt with the value of the u64.

pub fn to_u64(&self) -> u64

Returns the BigInt as a u64.

Panics

When the BigInt is greater than u64::MAX.

pub fn from_i64(env: &Env, i: i64) -> BigInt

Creates a BigInt with the value of the i64.

pub fn to_i64(&self) -> i64

Returns the BigInt as a i64.

Panics

When the BigInt is greater than i64::MAX.

pub fn from_u32(env: &Env, u: u32) -> BigInt

Creates a BigInt with the value of the u32.

pub fn to_u32(&self) -> u32

Returns the BigInt as a u32.

Panics

When the BigInt is greater than u32::MAX.

pub fn from_i32(env: &Env, i: i32) -> BigInt

Creates a BigInt with the value of the i32.

pub fn to_i32(&self) -> i32

Returns the BigInt as a i32.

Panics

When the BigInt is greater than i32::MAX.

pub fn gcd(&self, other: BigInt) -> BigInt

Returns the greatest common divisor of the BigInt and other.

pub fn lcm(&self, other: BigInt) -> BigInt

Returns the lowest common multiple of the BigInt and other.

pub fn pow(&self, power: BigInt) -> BigInt

Returns the BigInt raised to the power specified.

pub fn pow_mod(&self, q: BigInt, m: BigInt) -> BigInt

Returns p.pow(q) mod m.

Panics

When q is negative or m is zero.

pub fn sqrt(&self) -> BigInt

Returns the square root of the BigInt.

pub fn is_zero(&self) -> bool

Returns true if the BigInt is zero.

pub fn bits(&self) -> u32

Returns the minimum number of bits required to store the BigInt.

Trait Implementations

impl Add<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for BigInt

type Output = BigInt

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i64> for BigInt

type Output = BigInt

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u32> for BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, rhs: u32) -> 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 BitAnd<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<i32> for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<i64> for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<u32> for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<u64> for BigInt

type Output = BigInt

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<i32> for BigInt

type Output = BigInt

The resulting type after applying the | operator.

fn bitor(self, rhs: i32) -> Self::Output

Performs the | operation.

impl BitOr<i64> for BigInt

type Output = BigInt

The resulting type after applying the | operator.

fn bitor(self, rhs: i64) -> Self::Output

Performs the | operation.

impl BitOr<u32> for BigInt

type Output = BigInt

The resulting type after applying the | operator.

fn bitor(self, rhs: u32) -> Self::Output

Performs the | operation.

impl BitOr<u64> for BigInt

type Output = BigInt

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<i32> for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<i64> for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<u32> for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<u64> for BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for BigInt

fn clone(&self) -> BigInt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BigInt

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

Formats the value using the given formatter.

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

Performs the / operation.

impl Div<i32> for BigInt

type Output = BigInt

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i64> for BigInt

type Output = BigInt

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<u32> for BigInt

type Output = BigInt

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> 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 From<BigInt> for EnvVal

fn from(b: BigInt) -> Self

Converts to this type from the input type.

impl From<BigInt> for EnvVal<Env, Object>

fn from(b: BigInt) -> Self

Converts to this type from the input type.

impl From<BigInt> for RawVal

fn from(b: BigInt) -> Self

Converts to this type from the input type.

impl From<EnvVal<Env, i32>> for BigInt

fn from(ev: EnvType<i32>) -> Self

Converts to this type from the input type.

impl From<EnvVal<Env, i64>> for BigInt

fn from(ev: EnvType<i64>) -> Self

Converts to this type from the input type.

impl From<EnvVal<Env, u32>> for BigInt

fn from(ev: EnvType<u32>) -> Self

Converts to this type from the input type.

impl From<EnvVal<Env, u64>> for BigInt

fn from(ev: EnvType<u64>) -> Self

Converts to this type from the input type.

impl IntoVal<Env, BigInt> for i32

fn into_val(self, env: &Env) -> BigInt

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, BigInt> for i64

fn into_val(self, env: &Env) -> BigInt

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, BigInt> for u32

fn into_val(self, env: &Env) -> BigInt

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, BigInt> for u64

fn into_val(self, env: &Env) -> BigInt

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl Mul<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for BigInt

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i64> for BigInt

type Output = BigInt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u32> for BigInt

type Output = BigInt

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> 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 Neg for BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for BigInt

type Output = BigInt

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for BigInt

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<BigInt> for BigInt

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

impl PartialEq<i32> for BigInt

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

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

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

This method tests for !=.

impl PartialEq<i64> for BigInt

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

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

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

This method tests for !=.

impl PartialEq<u32> for BigInt

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

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

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

This method tests for !=.

impl PartialEq<u64> for BigInt

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

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

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

This method tests for !=.

impl PartialOrd<BigInt> for BigInt

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 PartialOrd<i32> for BigInt

fn partial_cmp(&self, other: &i32) -> 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 PartialOrd<i64> for BigInt

fn partial_cmp(&self, other: &i64) -> 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 PartialOrd<u32> for BigInt

fn partial_cmp(&self, other: &u32) -> 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 PartialOrd<u64> for BigInt

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

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

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

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

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

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

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

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

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

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

impl Rem<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<i32> for BigInt

type Output = BigInt

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<i64> for BigInt

type Output = BigInt

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<u32> for BigInt

type Output = BigInt

The resulting type after applying the % operator.

fn rem(self, rhs: u32) -> 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 Shl<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<i32> for BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<i64> for BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<u32> for BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<u64> for BigInt

type Output = BigInt

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shr<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<i32> for BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<i64> for BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u32> for BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u64> for BigInt

type Output = BigInt

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Sub<BigInt> for BigInt

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i32> for BigInt

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i64> for BigInt

type Output = BigInt

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u32> for BigInt

type Output = BigInt

The resulting type after applying the - operator.

fn sub(self, rhs: u32) -> 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 TryFrom<&BigInt> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BigInt> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BigInt> for i32

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BigInt> for i64

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BigInt> for u32

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BigInt> for u64

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<EnvVal<Env, Object>> for BigInt

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(obj: EnvVal<Env, Object>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<EnvVal<Env, RawVal>> for BigInt

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ev: EnvVal) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<EnvVal<Env, ScVal>> for BigInt

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: EnvType<ScVal>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryIntoVal<Env, BigInt> for RawVal

type Error = ConversionError

fn try_into_val(self, env: &Env) -> Result<BigInt, Self::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl TryIntoVal<Env, BigInt> for ScVal

type Error = ConversionError

fn try_into_val(self, env: &Env) -> Result<BigInt, Self::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl Eq for BigInt