Struct Amount 

pub struct Amount(/* private fields */);

A 128-bit signed amount.

This is a general purpose signed integer, but is primarily used to represent the smallest unit of value in resources/vaults etc.

This allows Tari to support a massive number tokens within resources. e.g. 2 ETH = 2 x 10^18 Gwei.

Implementations

impl Amount

pub const BITS: usize

pub const BYTE_SIZE: usize

pub const MAX: Amount

The maximum value that an Amount can hold.

pub const MIN: Amount

The minimum value that an Amount can hold.

pub const NUM_U64_DIGITS: usize

The number of u64 digits used to represent a Amount i.e. 2

pub const ONE: Amount

The value of one, represented as an Amount.

pub const ONE_HUNDRED: Amount

The value of one hundred, represented as an Amount.

pub const ONE_THOUSAND: Amount

The value of one thousand, represented as an Amount.

pub const TEN: Amount

The value of ten, represented as an Amount.

pub const ZERO: Amount

The value of zero, represented as an Amount.

pub const fn new(amount: u128) -> Amount

Creates a new Amount from an integer value.

pub fn from_integer<T>(amount: T) -> Amount

where T: Into<u128>,

Creates a new Amount from an integer value.

pub const fn from_usize(value: usize) -> Amount

pub const fn zero() -> Amount

A value of zero.

pub const fn is_zero(&self) -> bool

Returns true if the amount is zero.

pub const fn is_positive(&self) -> bool

Returns true if the amount is positive (greater than zero).

pub const fn is_negative(&self) -> bool

Always returns false since this type cannot represent negative values. This method is provided for symmetry with other amount types that may be signed.

pub const fn from_u64(value: u64) -> Amount

pub const fn to_u128(&self) -> u128

pub const fn checked_add(&self, other: Amount) -> Option<Amount>

Returns the value of this amount + other. Returns None if the result underflows or overflows.

pub const fn saturating_add(&self, other: Amount) -> Amount

Returns the sum of two amounts, saturating at i64::MAX if the result exceeds it.

pub const fn checked_sub(&self, other: Amount) -> Option<Amount>

Returns the difference of two amounts, saturating at 0 if the result is negative.

pub fn sum_from_positive<A, I>(iter: I) -> Option<Amount>

where A: Into<Amount>, I: Iterator<Item = A>,

pub const fn saturating_sub(&self, other: Amount) -> Amount

Returns the difference of two amounts, saturating at Amount::MIN if the result underflows. If negative results are not desired, use saturating_sub_positive.

pub const fn checked_mul(&self, other: Amount) -> Option<Amount>

Returns the product of two amounts, returning None if the result overflows.

pub const fn saturating_mul(&self, other: Amount) -> Amount

Returns the product of two amounts, saturating at i64::MAX if the result exceeds it.

pub const fn checked_div(&self, other: Amount) -> Option<Amount>

Returns the quotient of two amounts, returning None if the divisor is zero or if the result overflows.

pub const fn checked_div_ceil(&self, other: Amount) -> Option<Amount>

Returns the quotient of two amounts, returning None if the divisor is zero or if the result overflows.

pub const fn div_ceil(&self, other: Amount) -> Amount

Returns the quotient of two amounts, returning None if the divisor is zero or if the result overflows.

Panics

If the divisor is zero, this function will panic.

pub const fn saturating_div(&self, other: &Amount) -> Amount

Returns the quotient of two amounts, saturating at i64::MAX if the result exceeds it.

pub fn to_u64_checked(&self) -> Option<u64>

Returns the value as an u64 if possible, otherwise returns None. Since the internal representation is i64, this will return None if the value is negative.

pub fn to_canonical_bytes(&self) -> [u8; 16]

Returns the value as an BYTE_SIZE byte array in canonical order (little-endian).

pub fn to_le_bytes(&self) -> [u8; 16]

pub fn from_le_bytes(bytes: [u8; 16]) -> Amount

pub const fn from_le_digits(digits: [u64; 2]) -> Amount

pub fn from_le_slice(bytes: &[u8]) -> Option<Amount>

Creates an integer value from a slice of bytes in little endian. The value is wrapped in an Option as the bytes may represent an integer too large to be represented by the type.

If the length of the slice is shorter than Self::BYTES, the slice is padded with zeros or ones at the end so that it’s length equals Self::BYTES.

If the length of the slice is longer than Self::BYTES, None will be returned, unless the bytes have trailing zeros that can be removed until the length of the slice equals Self::BYTES.

pub fn to_le_digits(&self) -> [u64; 2]

pub fn non_negative_checked(self) -> Option<Amount>

If the amount is negative (< 0), returns None, otherwise returns Some(self).

pub fn negative_checked(self) -> Option<Amount>

If the amount is positive (> 0), returns None, otherwise returns Some(self).

pub const fn pow(&self, exp: u32) -> Amount

Returns the amount raised to the power of exp.

pub const fn checked_pow(&self, exp: u32) -> Option<Amount>

Returns the amount raised to the power of exp, returning None if the result overflows.

pub const fn try_from_str_radix(s: &str, radix: u32) -> Option<Amount>

Parses a string as an Amount in the specified radix.

This function works in constant context, allowing it to be used to define constants.

pub const fn from_str_radix(s: &str, radix: u32) -> Amount

Parses a string as an Amount in the specified radix.

Panics

Panics if string parsing fails

pub fn to_decimal_string(&self, decimals: u32) -> String

Formats the amount as a decimal string with the specified number of decimal places.

Panics

Panics if decimals is greater than 57.

pub fn fmt_decimals<F>(&self, f: &mut F, decimals: u32) -> Result<(), Error>

where F: Write,

Trait Implementations

impl Add<u64> for Amount

type Output = Amount

The resulting type after applying the + operator.

fn add(self, other: u64) -> <Amount as Add<u64>>::Output

Performs the + operation.

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Amount

fn add_assign(&mut self, other: Amount)

Performs the += operation.

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl Default for Amount

fn default() -> Amount

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Amount

fn deserialize<D>( deserializer: D, ) -> Result<Amount, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Formats the value using the given formatter.

impl Div<u64> for Amount

type Output = Amount

The resulting type after applying the / operator.

fn div(self, other: u64) -> <Amount as Div<u64>>::Output

Performs the / operation.

impl Div for Amount

type Output = Amount

The resulting type after applying the / operator.

fn div(self, other: Amount) -> Amount

Performs the / operation.

impl DivAssign for Amount

fn div_assign(&mut self, other: Amount)

Performs the /= operation.

impl From<u128> for Amount

fn from(value: u128) -> Amount

Converts to this type from the input type.

impl From<u16> for Amount

fn from(value: u16) -> Amount

Converts to this type from the input type.

impl From<u32> for Amount

fn from(value: u32) -> Amount

Converts to this type from the input type.

impl From<u64> for Amount

fn from(value: u64) -> Amount

Converts to this type from the input type.

impl From<u8> for Amount

fn from(value: u8) -> Amount

Converts to this type from the input type.

impl FromStr for Amount

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Amount, <Amount as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Amount

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 Mul<u64> for Amount

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, other: u64) -> <Amount as Mul<u64>>::Output

Performs the * operation.

impl Mul for Amount

type Output = Amount

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Amount

fn mul_assign(&mut self, other: Amount)

Performs the *= operation.

impl Ord for Amount

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

fn eq(&self, other: &i128) -> 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 PartialEq<i16> for Amount

fn eq(&self, other: &i16) -> 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 PartialEq<i32> for Amount

fn eq(&self, other: &i32) -> 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 PartialEq<i64> for Amount

fn eq(&self, other: &i64) -> 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 PartialEq<i8> for Amount

fn eq(&self, other: &i8) -> 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 PartialEq<isize> for Amount

fn eq(&self, other: &isize) -> 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 PartialEq<u128> for Amount

fn eq(&self, other: &u128) -> 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 PartialEq<u16> for Amount

fn eq(&self, other: &u16) -> 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 PartialEq<u32> for Amount

fn eq(&self, other: &u32) -> 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 PartialEq<u64> for Amount

fn eq(&self, other: &u64) -> 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 PartialEq<u8> for Amount

fn eq(&self, other: &u8) -> 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 PartialEq<usize> for Amount

fn eq(&self, other: &usize) -> 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 PartialEq for Amount

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

fn partial_cmp(&self, other: &i128) -> 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 PartialOrd<i16> for Amount

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

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

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 PartialOrd<i64> for Amount

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

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 PartialOrd<i8> for Amount

fn partial_cmp(&self, other: &i8) -> 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 PartialOrd<u128> for Amount

fn partial_cmp(&self, other: &u128) -> 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 PartialOrd<u16> for Amount

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

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

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 PartialOrd<u64> for Amount

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

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 PartialOrd<u8> for Amount

fn partial_cmp(&self, other: &u8) -> 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 PartialOrd<usize> for Amount

fn partial_cmp(&self, other: &usize) -> 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 PartialOrd for Amount

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

type Output = Amount

The resulting type after applying the % operator.

fn rem(self, other: Amount) -> Amount

Performs the % operation.

impl RemAssign for Amount

fn rem_assign(&mut self, other: Amount)

Performs the %= operation.

impl Serialize for Amount

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 Sub<u64> for Amount

type Output = Amount

The resulting type after applying the - operator.

fn sub(self, other: u64) -> <Amount as Sub<u64>>::Output

Performs the - operation.

impl Sub for Amount

type Output = Amount

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Amount

fn sub_assign(&mut self, other: Amount)

Performs the -= operation.

impl Sum for Amount

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = Amount>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Amount> for usize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: Amount) -> Result<usize, <usize as TryFrom<Amount>>::Error>

Performs the conversion.

impl TryFrom<i128> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Amount, <Amount as TryFrom<i128>>::Error>

Performs the conversion.

impl TryFrom<i16> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Amount, <Amount as TryFrom<i16>>::Error>

Performs the conversion.

impl TryFrom<i32> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Amount, <Amount as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<i64> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Amount, <Amount as TryFrom<i64>>::Error>

Performs the conversion.

impl TryFrom<i8> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Amount, <Amount as TryFrom<i8>>::Error>

Performs the conversion.

impl TryFrom<isize> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Amount, <Amount as TryFrom<isize>>::Error>

Performs the conversion.

impl TryFrom<usize> for Amount

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Amount, <Amount as TryFrom<usize>>::Error>

Performs the conversion.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount