Struct CurrencyCollection

pub struct CurrencyCollection {
    pub tokens: Tokens,
    pub other: ExtraCurrencyCollection,
}

Amounts collection.

Fields

tokens: Tokens

Amount in native currency.

other: ExtraCurrencyCollection

Amounts in other currencies.

Implementations

impl CurrencyCollection

pub const ZERO: Self

The additive identity for the currency collection (with empty extra currencies).

pub const fn new(tokens: u128) -> Self

Creates a new currency collection with from the specified tokens amount and empty extra currency collection.

pub fn is_zero(&self) -> bool

Returns whether balance in tokens and extra currencies is empty.

pub const fn bit_len(&self) -> u16

Returns the number of data bits that this struct occupies.

pub fn checked_add(&self, other: &Self) -> Result<Self, Error>

Checked currency collection addition. Computes self + rhs for each currency, returning Err if overflow occurred or dictionaries had invalid structure.

pub fn checked_sub(&self, other: &Self) -> Result<Self, Error>

Checked currency collection subtraction. Computes self - rhs for each currency, returning Err if overflow occurred or dictionaries had invalid structure.

pub fn try_add_assign_tokens(&mut self, other: Tokens) -> Result<(), Error>

Tries to add the specified amount of native tokens to the collection.

pub fn try_sub_assign_tokens(&mut self, other: Tokens) -> Result<(), Error>

Tries to subtract the specified amount of native tokens from the collection.

pub fn try_add_assign(&mut self, other: &Self) -> Result<(), Error>

Tries to add an other currency collection to the current one.

pub fn try_sub_assign(&mut self, other: &Self) -> Result<(), Error>

Tries to subtract an other currency collection from the current one.

pub fn checked_clamp(&self, other: &Self) -> Result<Self, Error>

Returns the intersection between two currency collections.

Trait Implementations

impl AugDictExtra for CurrencyCollection

fn comp_add( left: &mut CellSlice<'_>, right: &mut CellSlice<'_>, b: &mut CellBuilder, cx: &dyn CellContext, ) -> Result<(), Error>

Merges two augmented values.

impl Clone for CurrencyCollection

fn clone(&self) -> CurrencyCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CurrencyCollection

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

Formats the value using the given formatter.

impl Default for CurrencyCollection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CurrencyCollection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExactSize for CurrencyCollection

fn exact_size(&self) -> Size

Exact size of the value when it is stored in a slice.

impl From<Tokens> for CurrencyCollection

fn from(tokens: Tokens) -> Self

Converts to this type from the input type.

impl<'tlb> Load<'tlb> for CurrencyCollection

fn load_from(__slice: &mut CellSlice<'tlb>) -> Result<Self, Error>

Tries to load itself from a cell slice.

impl PartialEq for CurrencyCollection

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

Tests for self and other values to be equal, and is used by ==.

const 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 Serialize for CurrencyCollection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Store for CurrencyCollection

fn store_into( &self, __builder: &mut CellBuilder, __context: &dyn CellContext, ) -> Result<(), Error>

Tries to store itself into the cell builder.

impl Eq for CurrencyCollection

impl StructuralPartialEq for CurrencyCollection