Struct Balance 

pub struct Balance<C>(/* private fields */)
where
    C: Currency;

Represents a non-negative balance of some Currency.

The value is internally always stored in wei but always printed in human-readable format.

All arithmetic on this type is implicitly saturating at bounds given by U256.

Implementations

impl<C> Balance<C>

where C: Currency,

pub fn new_base<T>(value: T) -> Balance<C>

where T: Into<U256>,

Creates new balance in base units, instead of wei.

pub fn zero() -> Balance<C>

Zero balance.

pub fn is_zero(&self) -> bool

Checks if the balance is zero.

pub fn amount(&self) -> U256

Gets the amount in wei.

pub fn amount_in_base_units(&self) -> String

Returns the amount in base units (human-readable), not in wei.

pub fn format_in_wei(&self) -> String

Prints the balance formated in wei units.

Trait Implementations

impl<C, T> Add<T> for Balance<C>

where C: Currency, T: Into<U256>,

type Output = Balance<C>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <Balance<C> as Add<T>>::Output

Performs the + operation.

impl<C> Add for Balance<C>

where C: Currency,

type Output = Balance<C>

The resulting type after applying the + operator.

fn add(self, rhs: Balance<C>) -> <Balance<C> as Add>::Output

Performs the + operation.

impl<C, T> AddAssign<T> for Balance<C>

where C: Currency, T: Into<U256>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<C> AddAssign for Balance<C>

where C: Currency,

fn add_assign(&mut self, rhs: Balance<C>)

Performs the += operation.

impl<C> AsRef<U256> for Balance<C>

where C: Currency,

fn as_ref(&self) -> &U256

Converts this type into a shared reference of the (usually inferred) input type.

impl<C> Clone for Balance<C>

where C: Clone + Currency,

fn clone(&self) -> Balance<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Balance<C>

where C: Currency,

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

Formats the value using the given formatter.

impl<C> Default for Balance<C>

where C: Default + Currency,

fn default() -> Balance<C>

Returns the “default value” for a type.

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

where C: Currency + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Display for Balance<C>

where C: Currency,

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

Formats the value using the given formatter.

impl<C, T> From<T> for Balance<C>

where C: Currency, T: Into<U256>,

fn from(value: T) -> Balance<C>

Converts to this type from the input type.

impl<C> FromStr for Balance<C>

where C: Currency,

type Err = GeneralError

The associated error which can be returned from parsing.

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

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

impl<C> Hash for Balance<C>

where C: Hash + Currency,

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<C> IntoEndian<32> for Balance<C>

where C: Currency,

fn from_be_bytes<T>(bytes: T) -> Balance<C>

where T: AsRef<[u8]>,

Create an instance from Big Endian bytes. Should panic if size is more than N.

fn from_le_bytes<T>(bytes: T) -> Balance<C>

where T: AsRef<[u8]>,

Create an instance from Little Endian bytes. Should panic if size is more than N.

fn to_le_bytes(self) -> [u8; 32]

Convert instance to Little Endian bytes.

fn to_be_bytes(self) -> [u8; 32]

Convert instance to Big Endian bytes.

impl<C, T> Mul<T> for Balance<C>

where C: Currency, T: Into<U256>,

type Output = Balance<C>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <Balance<C> as Mul<T>>::Output

Performs the * operation.

impl<C> Mul for Balance<C>

where C: Currency,

type Output = Balance<C>

The resulting type after applying the * operator.

fn mul(self, rhs: Balance<C>) -> <Balance<C> as Mul>::Output

Performs the * operation.

impl<C, T> MulAssign<T> for Balance<C>

where C: Currency, T: Into<U256>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<C> MulAssign for Balance<C>

where C: Currency,

fn mul_assign(&mut self, rhs: Balance<C>)

Performs the *= operation.

impl<C> Ord for Balance<C>

where C: Ord + Currency,

fn cmp(&self, other: &Balance<C>) -> 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<C> PartialEq for Balance<C>

where C: PartialEq + Currency,

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

where C: PartialOrd + Currency,

fn partial_cmp(&self, other: &Balance<C>) -> 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<C> Serialize for Balance<C>

where C: Currency + Serialize,

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<C, T> Sub<T> for Balance<C>

where C: Currency, T: Into<U256>,

type Output = Balance<C>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> <Balance<C> as Sub<T>>::Output

Performs the - operation.

impl<C> Sub for Balance<C>

where C: Currency,

type Output = Balance<C>

The resulting type after applying the - operator.

fn sub(self, rhs: Balance<C>) -> <Balance<C> as Sub>::Output

Performs the - operation.

impl<C, T> SubAssign<T> for Balance<C>

where C: Currency, T: Into<U256>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<C> SubAssign for Balance<C>

where C: Currency,

fn sub_assign(&mut self, rhs: Balance<C>)

Performs the -= operation.

impl<C> Sum for Balance<C>

where C: Currency,

fn sum<I>(iter: I) -> Balance<C>

where I: Iterator<Item = Balance<C>>,

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

impl<C> UnitaryFloatOps for Balance<C>

where C: Currency,

fn mul_f64(&self, rhs: f64) -> Result<Balance<C>, GeneralError>

Multiply with float in the interval [0.0, 1.0]

fn div_f64(&self, rhs: f64) -> Result<Balance<C>, GeneralError>

Divide by float in the interval (0.0, 1.0]

impl<C> Copy for Balance<C>

where C: Copy + Currency,

impl<C> Eq for Balance<C>

where C: Eq + Currency,

impl<C> StructuralPartialEq for Balance<C>

where C: Currency,