Struct TokenAmount 

pub struct TokenAmount(TokenAmount);

Tuple Fields

0: TokenAmount

Implementations

impl TokenAmount

pub const DECIMALS: usize = 18usize

The logical number of decimal places of a token unit.

pub const PRECISION: u64 = 1_000_000_000_000_000_000u64

The logical precision of a token unit.

pub fn atto(&self) -> &BigInt

Returns the quantity of indivisible units.

pub fn from_atto(atto: impl Into<BigInt>) -> Self

pub fn from_nano(nano: impl Into<BigInt>) -> Self

pub fn from_whole(fil: impl Into<BigInt>) -> Self

pub fn div_rem(&self, other: impl Into<BigInt>) -> (TokenAmount, TokenAmount)

pub fn div_ceil(&self, other: impl Into<BigInt>) -> TokenAmount

pub fn div_floor(&self, other: impl Into<BigInt>) -> TokenAmount

Methods from Deref<Target = TokenAmount_latest>

pub const DECIMALS: usize = 18usize

pub const PRECISION: u64 = 1_000_000_000_000_000_000u64

pub fn atto(&self) -> &BigInt

Returns the quantity of indivisible units.

pub fn is_zero(&self) -> bool

pub fn is_positive(&self) -> bool

pub fn is_negative(&self) -> bool

pub fn div_rem(&self, other: impl Into<BigInt>) -> (TokenAmount, TokenAmount)

pub fn div_ceil(&self, other: impl Into<BigInt>) -> TokenAmount

pub fn div_floor(&self, other: impl Into<BigInt>) -> TokenAmount

Trait Implementations

impl Add<&TokenAmount> for &TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&TokenAmount> for TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<TokenAmount> for &TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for TokenAmount

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for TokenAmount

fn clone(&self) -> TokenAmount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenAmount

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

Formats the value using the given formatter.

impl Default for TokenAmount

fn default() -> TokenAmount

Returns the “default value” for a type.

impl Deref for TokenAmount

type Target = TokenAmount

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TokenAmount

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for TokenAmount

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenAmount

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

Formats the value using the given formatter.

impl From<&TokenAmount> for EthBigInt

fn from(amount: &TokenAmount) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for Pretty

fn from(value: &TokenAmount) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for TokenAmount

fn from(other: &TokenAmount_v2) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for TokenAmount

fn from(other: &TokenAmount_v3) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for TokenAmount

fn from(other: &TokenAmount_v4) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for TokenAmount

fn from(other: &TokenAmount) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for TokenAmount

fn from(other: &TokenAmount) -> Self

Converts to this type from the input type.

impl From<&TokenAmount> for TokenAmount

fn from(other: &TokenAmount) -> Self

Converts to this type from the input type.

impl From<BigInt> for TokenAmount

fn from(value: BigInt) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for BigInt

fn from(value: TokenAmount) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for EthBigInt

fn from(amount: TokenAmount) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(other: TokenAmount_v2) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(other: TokenAmount_v3) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(other: TokenAmount_v4) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(other: TokenAmount) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(other: TokenAmount) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(other: TokenAmount) -> Self

Converts to this type from the input type.

impl GetSize for TokenAmount

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl HasLotusJson for TokenAmount

type LotusJson = TokenAmountLotusJson

The struct representing JSON. You should #[derive(Deserialize, Serialize)] on it.

fn into_lotus_json(self) -> Self::LotusJson

fn from_lotus_json(lotus_json: Self::LotusJson) -> Self

fn into_lotus_json_value(self) -> Result<Value>

fn into_lotus_json_string(self) -> Result<String>

fn into_lotus_json_string_pretty(self) -> Result<String>

impl Hash for TokenAmount

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 Mul<BigInt> for &TokenAmount

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<BigInt> for TokenAmount

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i64> for &TokenAmount

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i64> for TokenAmount

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for &TokenAmount

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for TokenAmount

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<BigInt> for TokenAmount

fn mul_assign(&mut self, rhs: BigInt)

Performs the *= operation.

impl Ord for TokenAmount

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

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

fn partial_cmp(&self, other: &TokenAmount) -> 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 Serialize for TokenAmount

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&TokenAmount> for TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<TokenAmount> for &TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for TokenAmount

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl TokenAmountPretty for TokenAmount

fn pretty(&self) -> Pretty

Note the following format specifiers:

• {:#}: print number of FIL, not e.g milliFIL
• {:.4}: round to 4 significant figures
• {:.#4}: both

let amount = TokenAmount::from_nano(1500);

// Defaults to precise, with SI prefix
assert_eq!("1.5 microFIL", format!("{}", amount.pretty()));

// Rounded to 1 s.f
assert_eq!("~2 microFIL", format!("{:.1}", amount.pretty()));

// Show absolute FIL
assert_eq!("0.0000015 FIL", format!("{:#}", amount.pretty()));

// Rounded absolute FIL
assert_eq!("~0.000002 FIL", format!("{:#.1}", amount.pretty()));

// We only indicate lost precision when relevant
assert_eq!("1.5 microFIL", format!("{:.2}", amount.pretty()));

Formatting

• We select the most diminutive SI prefix (or not!) that allows us to display an integer amount.

impl Zero for TokenAmount

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 Eq for TokenAmount

impl StructuralPartialEq for TokenAmount