Struct Currency

pub struct Currency {
    pub symbol: String,
    pub decimals: u32,
    pub metadata: Option<Value>,
}

Currency : Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).

Fields

symbol: String

Canonical symbol associated with a currency.

decimals: u32

Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10.

metadata: Option<Value>

Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token.

Implementations

impl Currency

pub fn new(symbol: String, decimals: u32) -> Currency

Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).

Trait Implementations

impl Clone for Currency

fn clone(&self) -> Currency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Currency

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

Formats the value using the given formatter.

impl Default for Currency

fn default() -> Currency

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Currency

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Currency

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

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 Eq for Currency

impl StructuralPartialEq for Currency