Struct Balance

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

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: Currency> Balance<C>

pub fn new_base<T: Into<U256>>(value: T) -> Self

Creates new balance in base units, instead of wei.

pub fn zero() -> Self

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: Currency, T: Into<U256>> Add<T> for Balance<C>

type Output = Balance<C>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C: Currency> Add for Balance<C>

type Output = Balance<C>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C: Currency, T: Into<U256>> AddAssign<T> for Balance<C>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<C: Currency> AddAssign for Balance<C>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

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

fn as_ref(&self) -> &U256

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

impl<C: Clone + Currency> Clone for Balance<C>

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: Currency> Debug for Balance<C>

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

Formats the value using the given formatter.

impl<C: Default + Currency> Default for Balance<C>

fn default() -> Balance<C>

Returns the “default value” for a type.

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

where C: Deserialize<'de> + Currency,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: Currency> Display for Balance<C>

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

Formats the value using the given formatter.

impl<C: Currency, T: Into<U256>> From<T> for Balance<C>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<C: Currency> FromStr for Balance<C>

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<C: Hash + Currency> Hash for Balance<C>

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

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

fn from_be_bytes<T: AsRef<[u8]>>(bytes: T) -> Self

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

fn from_le_bytes<T: AsRef<[u8]>>(bytes: T) -> Self

Create 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: Currency, T: Into<U256>> Mul<T> for Balance<C>

type Output = Balance<C>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<C: Currency> Mul for Balance<C>

type Output = Balance<C>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<C: Currency, T: Into<U256>> MulAssign<T> for Balance<C>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<C: Currency> MulAssign for Balance<C>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<C: Ord + Currency> Ord for Balance<C>

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 + Currency> PartialEq for Balance<C>

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 + Currency> PartialOrd for Balance<C>

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: Serialize + Currency,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: Currency, T: Into<U256>> Sub<T> for Balance<C>

type Output = Balance<C>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C: Currency> Sub for Balance<C>

type Output = Balance<C>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C: Currency, T: Into<U256>> SubAssign<T> for Balance<C>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<C: Currency> SubAssign for Balance<C>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<C: Currency> Sum for Balance<C>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

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

impl<C: Currency> UnitaryFloatOps for Balance<C>

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<C: Copy + Currency> Copy for Balance<C>

impl<C: Eq + Currency> Eq for Balance<C>

impl<C: Currency> StructuralPartialEq for Balance<C>