Struct TokenAmount 

pub struct TokenAmount<const DECIMALS: usize> { /* private fields */ }

Implementations

impl<const DECIMALS: usize> TokenAmount<DECIMALS>

pub fn new(amount: U256, precision: usize) -> Self

pub fn amount(&self) -> U256

pub fn precision(&self) -> usize

Methods from Deref<Target = U256>

pub const MAX: U256

pub fn low_u32(&self) -> u32

Conversion to u32

pub fn low_u64(&self) -> u64

Low word (u64)

pub fn as_u32(&self) -> u32

Conversion to u32 with overflow checking

Panics

Panics if the number is larger than 2^32.

pub fn as_u64(&self) -> u64

Conversion to u64 with overflow checking

Panics

Panics if the number is larger than u64::max_value().

pub fn as_usize(&self) -> usize

Conversion to usize with overflow checking

Panics

Panics if the number is larger than usize::max_value().

pub fn is_zero(&self) -> bool

Whether this is zero.

pub fn bits(&self) -> usize

Return the least number of bits needed to represent the number

pub fn bit(&self, index: usize) -> bool

Return if specific bit is set.

Panics

Panics if index exceeds the bit width of the number.

pub fn leading_zeros(&self) -> u32

Returns the number of leading zeros in the binary representation of self.

pub fn trailing_zeros(&self) -> u32

Returns the number of trailing zeros in the binary representation of self.

pub fn byte(&self, index: usize) -> u8

Return specific byte.

Panics

Panics if index exceeds the byte width of the number.

pub fn to_big_endian(&self, bytes: &mut [u8])

Write to the slice in big-endian format.

pub fn to_little_endian(&self, bytes: &mut [u8])

Write to the slice in little-endian format.

pub fn integer_sqrt(&self) -> U256

Compute the highest n such that n * n <= self.

pub fn low_u128(&self) -> u128

Low 2 words (u128)

pub fn as_u128(&self) -> u128

Conversion to u128 with overflow checking

Panics

Panics if the number is larger than 2^128.

pub const MIN: U256

Trait Implementations

impl<const DECIMALS: usize> Clone for TokenAmount<DECIMALS>

fn clone(&self) -> TokenAmount<DECIMALS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const DECIMALS: usize> Copy for TokenAmount<DECIMALS>

impl<const DECIMALS: usize> Debug for TokenAmount<DECIMALS>

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

Formats the value using the given formatter.

impl<const DECIMALS: usize> Deref for TokenAmount<DECIMALS>

type Target = U256

The resulting type after dereferencing.

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

Dereferences the value.

impl<const DECIMALS: usize> Display for TokenAmount<DECIMALS>

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

Formats the value using the given formatter.

impl<const DECIMALS: usize> From<&U256> for TokenAmount<DECIMALS>

fn from(amount: &U256) -> Self

Converts to this type from the input type.

impl<const DECIMALS: usize> From<U256> for TokenAmount<DECIMALS>

fn from(amount: U256) -> Self

Converts to this type from the input type.

impl<const DECIMALS: usize> FromStr for TokenAmount<DECIMALS>

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<const DECIMALS: usize> PartialEq for TokenAmount<DECIMALS>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const DECIMALS: usize> PartialOrd for TokenAmount<DECIMALS>

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

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.