Struct fvm_shared::econ::TokenAmount

pub struct TokenAmount { /* private fields */ }

A quantity of native tokens. A token amount is an integer, but has a human interpretation as a value with 18 decimal places. This is a new-type in order to prevent accidental conversion from other BigInts. From/Into BigInt is missing by design.

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 from_atto(atto: impl Into<BigInt>) -> Self

Creates a token amount from a quantity of indivisible units (10^-18 whole units).

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

Creates a token amount from nanoFIL.

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

Creates a token amount from a quantity of whole units (10^18 indivisible units).

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

impl TokenAmount

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<'a, 'b> Add<&'b TokenAmount> for &'a TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

fn add(self, other: &'b TokenAmount) -> TokenAmount

Performs the + operation.

impl<'b> Add<&'b TokenAmount> for TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

fn add(self, other: &'b TokenAmount) -> TokenAmount

Performs the + operation.

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

type Output = TokenAmount

The resulting type after applying the + operator.

fn add(self, other: TokenAmount) -> TokenAmount

Performs the + operation.

impl Add<TokenAmount> for TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

fn add(self, other: TokenAmount) -> TokenAmount

Performs the + operation.

impl<'a> AddAssign<&'a TokenAmount> for TokenAmount

fn add_assign(&mut self, other: &TokenAmount)

Performs the += operation.

impl AddAssign<TokenAmount> for TokenAmount

fn add_assign(&mut self, other: TokenAmount)

Performs the += operation.

impl Clone for TokenAmount

fn clone(&self) -> TokenAmount

Returns a copy 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<'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

Displays a token amount as a decimal in human units. To avoid any confusion over whether the value is in human-scale or indivisible units, the display always includes a decimal point.

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

Formats the value using the given formatter.

impl From<TokenAmount> for TokenAmount

fn from(v: TokenAmount) -> Self

Converts to this type from the input type.

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<'a, 'b> Mul<&'b TokenAmount> for &'a BigInt

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a i128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a i16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a i32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a i64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a i8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a u128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a u16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a u32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a u64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, 'b> Mul<&'b TokenAmount> for &'a u8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for BigInt

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for i128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for i16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for i32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for i64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for i8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for u128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for u16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for u32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for u64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'b> Mul<&'b TokenAmount> for u8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: &'b TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a, T> Mul<T> for &'a TokenAmountwhere &'a BigInt: Mul<T, Output = BigInt>,

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<T> for TokenAmountwhere BigInt: Mul<T, Output = BigInt>,

type Output = TokenAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a BigInt

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a i128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a i16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a i32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a i64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a i8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a u128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a u16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a u32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a u64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<'a> Mul<TokenAmount> for &'a u8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for BigInt

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for i128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for i16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for i32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for i64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for i8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for u128

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for u16

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for u32

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for u64

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl Mul<TokenAmount> for u8

type Output = TokenAmount

The resulting type after applying the * operator.

fn mul(self, other: TokenAmount) -> TokenAmount

Performs the * operation.

impl<T> MulAssign<T> for TokenAmountwhere BigInt: MulAssign<T>,

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<'a> Neg for &'a TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

fn neg(self) -> TokenAmount

Performs the unary - operation.

impl Neg for TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

fn neg(self) -> TokenAmount

Performs the unary - operation.

impl Ord for TokenAmount

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TokenAmount> for TokenAmount

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

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 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<'a, 'b> Sub<&'b TokenAmount> for &'a TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

fn sub(self, other: &'b TokenAmount) -> TokenAmount

Performs the - operation.

impl<'b> Sub<&'b TokenAmount> for TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

fn sub(self, other: &'b TokenAmount) -> TokenAmount

Performs the - operation.

impl<'a> Sub<TokenAmount> for &'a TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

fn sub(self, other: TokenAmount) -> TokenAmount

Performs the - operation.

impl Sub<TokenAmount> for TokenAmount

type Output = TokenAmount

The resulting type after applying the - operator.

fn sub(self, other: TokenAmount) -> TokenAmount

Performs the - operation.

impl<'a> SubAssign<&'a TokenAmount> for TokenAmount

fn sub_assign(&mut self, other: &TokenAmount)

Performs the -= operation.

impl SubAssign<TokenAmount> for TokenAmount

fn sub_assign(&mut self, other: TokenAmount)

Performs the -= operation.

impl<'a> Sum<&'a TokenAmount> for TokenAmount

fn sum<I: Iterator<Item = &'a TokenAmount>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum<TokenAmount> for TokenAmount

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> TryFrom<&'a TokenAmount> for TokenAmount

type Error = TryFromBigIntError<()>

The type returned in the event of a conversion error.

fn try_from(v: &'a TokenAmount) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TokenAmount> for TokenAmount

type Error = TryFromBigIntError<()>

The type returned in the event of a conversion error.

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

Performs the conversion.

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

impl StructuralPartialEq for TokenAmount