Struct soroban_sdk::BigInt

source · [−]

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

Expand description

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

source

Creates a BigInt with a Sign and Bytes.

If the Sign is Sign::NoSign the bytes is ignored and the returned value is zero.

Bytes are in big-endian order.

source

pub fn from_sign_and_slice(env: &Env, s: &Sign, bytes: &[u8]) -> BigInt

Creates a BigInt with the slice.

The sign of the BigInt is not negative. Bytes are in big-endian order.

source

pub fn to_bytes(&self) -> Bytes

source

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

Returns the lowest common multiple of the BigInt and other.

source

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

Returns the BigInt raised to the power specified.

source

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.

source

pub fn sqrt(&self) -> BigInt

Returns the square root of the BigInt.

source

pub fn is_zero(&self) -> bool

Returns true if the BigInt is zero.

source

pub fn bits(&self) -> u64

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

The resulting type after applying the & operator.

The resulting type after applying the | operator.

The resulting type after applying the ^ operator.

Performs copy-assignment from source. Read more

source

impl Debug for BigInt

source

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

Formats the value using the given formatter. Read more

source

The resulting type after applying the / operator.

The resulting type after applying the ! operator.

source

fn not(self) -> Self::Output

Performs the unary ! operation. Read more

source

impl Ord for BigInt

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

The resulting type after applying the << operator.

The resulting type after applying the >> operator.

The resulting type after applying the - operator.

impl !RefUnwindSafe for BigInt

impl !Send for BigInt

impl !Sync for BigInt

impl Unpin for BigInt

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Deserialize for Twhere
T: TryFromVal<Env, RawVal>,

type Error = <T as TryFromVal<Env, RawVal>>::Error

source

fn deserialize(env: &Env, b: &Bytes) -> Result<T, <T as Deserialize>::Error>

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T, Rhs> NumAssignOps<Rhs> for Twhere
T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,

source

impl<T, Rhs, Output> NumOps<Rhs, Output> for Twhere
T: Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Rem<Rhs, Output = Output> + Add<Rhs, Output = Output> + Sub<Rhs, Output = Output>,

source

Struct soroban_sdk::BigInt

Implementations

impl BigInt

pub fn env(&self) -> &Env

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

pub fn as_object(&self) -> &Object

pub fn to_object(&self) -> Object

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

pub fn from_bytes(b: &Bytes) -> BigInt

pub fn from_slice(env: &Env, bytes: &[u8]) -> BigInt

pub fn from_sign_and_bytes(s: &Sign, b: &Bytes) -> BigInt

pub fn from_sign_and_slice(env: &Env, s: &Sign, bytes: &[u8]) -> BigInt

pub fn to_bytes(&self) -> Bytes

pub fn sign(&self) -> Sign

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

pub fn to_u64(&self) -> u64

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

pub fn to_i64(&self) -> i64

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

pub fn to_u32(&self) -> u32

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

pub fn to_i32(&self) -> i32

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

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

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

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

pub fn sqrt(&self) -> BigInt

pub fn is_zero(&self) -> bool

pub fn bits(&self) -> u64

Trait Implementations

impl<'a> Add<&'a BigInt> for &'a BigInt

type Output = BigInt

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

impl<'a> Add<&'a BigInt> for &'a mut BigInt

type Output = BigInt

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

impl<'a> Add<&'a BigInt> for BigInt

type Output = BigInt

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

impl<'a> Add<&'a i32> for &'a BigInt

type Output = BigInt

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

impl<'a> Add<&'a i32> for &'a mut BigInt

type Output = BigInt

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

impl<'a> Add<&'a i32> for BigInt

type Output = BigInt

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

impl<'a> Add<&'a i64> for &'a BigInt

type Output = BigInt

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

impl<'a> Add<&'a i64> for &'a mut BigInt

type Output = BigInt

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

impl<'a> Add<&'a i64> for BigInt

type Output = BigInt

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

impl<'a> Add<&'a mut BigInt> for &'a BigInt

type Output = BigInt

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

impl<'a> Add<&'a mut BigInt> for &'a mut BigInt

type Output = BigInt

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

impl<'a> Add<&'a mut BigInt> for BigInt

type Output = BigInt

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

impl<'a> Add<&'a mut i32> for &'a BigInt

type Output = BigInt

fn add(self, rhs: &'a mut i32) -> Self::Output

impl<'a> Add<&'a mut i32> for &'a mut BigInt

type Output = BigInt

fn add(self, rhs: &'a mut i32) -> Self::Output

impl<'a> Add<&'a mut i32> for BigInt

type Output = BigInt

fn add(self, rhs: &'a mut i32) -> Self::Output

impl<'a> Add<&'a mut i64> for &'a BigInt

type Output = BigInt

fn add(self, rhs: &'a mut i64) -> Self::Output

impl<'a> Add<&'a mut i64> for &'a mut BigInt