Struct Balance

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

Represents balance of some coin or token.

Implementations

impl Balance

pub const SCALE: usize = 19usize

Number of digits in the base unit

pub fn new<T: Into<U256>>(value: T, balance_type: BalanceType) -> Self

Creates a new balance given the value and type

pub fn new_from_str(value: &str, balance_type: BalanceType) -> Self

Creates new balance of the given type from the base 10 integer string

pub fn zero(balance_type: BalanceType) -> Self

Creates zero balance of the given type

pub fn balance_type(&self) -> BalanceType

Retrieves the type (symbol) of the balance

pub fn of_same(&self, value: &str) -> Self

Creates balance of the given value with the same symbol

pub fn amount(&self) -> U256

pub fn is_zero(&self) -> bool

pub fn amount_base_units(&self) -> String

pub fn to_formatted_string(&self) -> String

pub fn to_value_string(&self) -> String

Trait Implementations

impl Add<&Balance> for Balance

type Output = Balance

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Into<U256>> Add<T> for Balance

type Output = Balance

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Balance

type Output = Balance

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Balance

fn clone(&self) -> Balance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Balance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Balance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Balance

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

Formats the value using the given formatter.

impl<T: Into<U256>> From<(T, BalanceType)> for Balance

fn from(value: (T, BalanceType)) -> Self

Converts to this type from the input type.

impl FromStr for Balance

type Err = GeneralError

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<T: Into<U256>> Mul<T> for Balance

type Output = Balance

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Balance

type Output = Balance

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Balance

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

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.

impl Serialize for Balance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Balance> for Balance

type Output = Balance

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Into<U256>> Sub<T> for Balance

type Output = Balance

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Balance

type Output = Balance

The resulting type after applying the - operator.

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

Performs the - operation.

impl UnitaryFloatOps for Balance

fn mul_f64(&self, rhs: f64) -> Result<Self>

Multiply with float in the interval [0.0, 1.0]

fn div_f64(&self, rhs: f64) -> Result<Self>

Divide by float in the interval (0.0, 1.0]

impl Copy for Balance

impl Eq for Balance

impl StructuralPartialEq for Balance