Struct TokenAmount 

pub struct TokenAmount { /* private fields */ }

Protocol level token (PLT) amount representation. The numerical amount represented is value * 10^(-decimals). The number of decimals in the token amount should always match the number of decimals for the token it represents an amount for.

Since the number of decimals always matches the token, TokenAmount can be considered a fixed point decimal and does not implement any floating point behaviour. The type also does not implement any arithmetic operations. This is intentional, any arithmetic operations and floating point operations should be performed using e.g. rust_decimal::Decimal before converting to TokenAmount. Notice also that the decimal part could be left out of the TokenAmount representation without loss of information, but it is there to make TokenAmount self-contained with regard to the numerical value represented. This enables additional validation, both programmatic and at user level.

Implementations

impl TokenAmount

pub fn from_raw(value: u64, decimals: u8) -> TokenAmount

Construct a TokenAmount from a value without decimal places and the number of decimals, meaning the token amount is computed as value * 10^(-decimals).

pub fn decimals(&self) -> u8

The number of decimals in the token amount.

The numerical amount represented by the TokenAmount is value * 10^(-decimals)

pub fn value(&self) -> u64

The amount of tokens as an unscaled integer value.

The numerical amount represented by the TokenAmount is value * 10^(-decimals)

pub fn try_from_rust_decimal( decimal: Decimal, decimals: u8, conversion_rule: ConversionRule, ) -> Result<TokenAmount, TokenAmountConversionError>

Converts rust_decimal::Decimal to a token amount of the same numerical value but represented with the given number of decimals. This may require rescaling but no rounding will be performed. If rounding is required to represent the numeric value with the given number of decimals, an error is returned.

The given number of decimals should be equal to the number of decimals for the token it represents an amount for.

pub fn try_to_rust_decimal(&self) -> Result<Decimal, TokenAmountConversionError>

Converts the token amount to a rust_decimal::Decimal of the same scale and same exact numerical value.

pub fn from_str( decimal_str: &str, decimals: u8, conversion_rule: ConversionRule, ) -> Result<TokenAmount, TokenAmountConversionError>

Interprets the given string as a decimal number (decimal separator must be “.” if specified) and parses it into a token amount of the same numerical value represented with the given number of decimals. If rounding is required to represent the numeric value with the given number of decimals, an error is returned.

The given number of decimals should be equal to the number of decimals for the token it represents an amount for.

Trait Implementations

impl CborDeserialize for TokenAmount

fn deserialize<C>(decoder: C) -> Result<TokenAmount, CborSerializationError>

where C: CborDecoder, TokenAmount: Sized,

Deserialize value from the given decoder

fn null() -> Option<Self>

where Self: Sized,

Produce value corresponding to null if possible for this type

impl CborSerialize for TokenAmount

fn serialize<C>(&self, encoder: C) -> Result<(), CborSerializationError>

where C: CborEncoder,

Serialize value to CBOR

fn is_null(&self) -> bool

Whether the value corresponds to null

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<TokenAmount, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenAmount

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

Formats the value using the given formatter.

impl Hash for TokenAmount

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TokenAmount> for TokenAmount

type Error = Status

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<TokenAmountJson> for TokenAmount

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from( json: TokenAmountJson, ) -> Result<TokenAmount, <TokenAmount as TryFrom<TokenAmountJson>>::Error>

Performs the conversion.

impl Copy for TokenAmount

impl Eq for TokenAmount

impl StructuralPartialEq for TokenAmount