Enum CurrencyCode

pub enum CurrencyCode {
    FiatCurrencyStart = 0,
    Jpy = 392,
    Gbp = 826,
    Usd = 840,
    Eur = 978,
    Xxx = 999,
    FiatCurrencyEnd = 1_000,
    CryptoStart = 1_001,
    Eth = 1002,
    Btc = 1003,
    CryptoEnd = 10_000,
    TokenStart = 10_001,
    Esp = 10002,
    TokenEnd = 99_999,
}

CurrencyCode represents an enumeration of all representable currency codes that are supported by the API.

CurrencyCode is an overloaded term for representing different types of currencies that could potentially be referenced / utilized within our system. This list is currently not exhaustive, and is expected to grow as needed. In fact, there may be too many entries in here as it stands.

The currency codes are annotated with a specific range that should map to the type that we’d expect.

Here’s the allocated range for the various currency codes:

• 1 - 999: Fiat Currency
• 1001 - 9999: Crypto Currency
• 10001 - 99999: Token Currency

For the Fiat Currencies, the CurrencyCode identifier is the Alpha3 representation of the ISO4217 standard. In addition, it’s numeric value is mapped to the ISO4217 standard as well.

No such standard currently exists for Crypto Currencies or for the Token based currencies, so we just utilize an enumeration for these that is based on their ordering. This is not guaranteed to be stable, and code should not depend on their order.

Variants

FiatCurrencyStart = 0

Jpy = 392

Gbp = 826

Usd = 840

Eur = 978

Xxx = 999

FiatCurrencyEnd = 1_000

CryptoStart = 1_001

Eth = 1002

Btc = 1003

CryptoEnd = 10_000

TokenStart = 10_001

Esp = 10002

TokenEnd = 99_999

Implementations

impl CurrencyCode

pub fn is_fiat(&self) -> bool

pub fn is_crypto(&self) -> bool

pub fn is_token(&self) -> bool

pub fn significant_digits(&self) -> usize

significant_digits represents the total number of significant digits that the currency in question utilizes.

This is used to determine the precision of the currency when formatting its representation as a string.

Trait Implementations

impl Clone for CurrencyCode

fn clone(&self) -> CurrencyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CurrencyCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CurrencyCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CurrencyCode

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

fmt formats the currency code into a human readable string

impl From<CurrencyCode> for String

fn from(currency: CurrencyCode) -> String

from converts the CurrencyCode into a string representation utilizing the fmt method for the CurrencyCode.

impl From<CurrencyCode> for u16

fn from(currency: CurrencyCode) -> u16

from converts the CurrencyCode into it’s mapped numeric representation.

impl Ord for CurrencyCode

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for CurrencyCode

type Error = InvalidCurrencyCodeError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CurrencyCode

impl Eq for CurrencyCode

impl StructuralPartialEq for CurrencyCode