Enum iso_currency::Currency

pub enum Currency {
    AED,
    AFN,
    ALL,
    AMD,
    ANG,
    AOA,
    ARS,
    AUD,
    AWG,
    AZN,
    BAM,
    BBD,
    BDT,
    BGN,
    BHD,
    BIF,
    BMD,
    BND,
    BOB,
    BOV,
    BRL,
    BSD,
    BTN,
    BWP,
    BYN,
    BZD,
    CAD,
    CDF,
    CHE,
    CHF,
    CHW,
    CLF,
    CLP,
    CNY,
    COP,
    COU,
    CRC,
    CUC,
    CUP,
    CVE,
    CZK,
    DJF,
    DKK,
    DOP,
    DZD,
    EGP,
    ERN,
    ETB,
    EUR,
    FJD,
    FKP,
    GBP,
    GEL,
    GHS,
    GIP,
    GMD,
    GNF,
    GTQ,
    GYD,
    HKD,
    HNL,
    HRK,
    HTG,
    HUF,
    IDR,
    ILS,
    INR,
    IQD,
    IRR,
    ISK,
    JMD,
    JOD,
    JPY,
    KES,
    KGS,
    KHR,
    KMF,
    KPW,
    KRW,
    KWD,
    KYD,
    KZT,
    LAK,
    LBP,
    LKR,
    LRD,
    LSL,
    LYD,
    MAD,
    MDL,
    MGA,
    MKD,
    MMK,
    MNT,
    MOP,
    MRU,
    MUR,
    MVR,
    MWK,
    MXN,
    MXV,
    MYR,
    MZN,
    NAD,
    NGN,
    NIO,
    NOK,
    NPR,
    NZD,
    OMR,
    PAB,
    PEN,
    PGK,
    PHP,
    PKR,
    PLN,
    PYG,
    QAR,
    RON,
    RSD,
    RUB,
    RWF,
    SAR,
    SBD,
    SCR,
    SDG,
    SEK,
    SGD,
    SHP,
    SLE,
    SLL,
    SOS,
    SRD,
    SSP,
    STN,
    SVC,
    SYP,
    SZL,
    THB,
    TJS,
    TMT,
    TND,
    TOP,
    TRY,
    TTD,
    TWD,
    TZS,
    UAH,
    UGX,
    USD,
    USN,
    UYI,
    UYU,
    UYW,
    UZS,
    VED,
    VES,
    VND,
    VUV,
    WST,
    XAF,
    XAG,
    XAU,
    XBA,
    XBB,
    XBC,
    XBD,
    XCD,
    XDR,
    XOF,
    XPD,
    XPF,
    XPT,
    XSU,
    XTS,
    XUA,
    XXX,
    YER,
    ZAR,
    ZMW,
    ZWL,
}

Variants

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

AWG

AZN

BAM

BBD

BDT

BGN

BHD

BIF

BMD

BND

BOB

BOV

BRL

BSD

BTN

BWP

BYN

BZD

CAD

CDF

CHE

CHF

CHW

CLF

CLP

CNY

COP

COU

CRC

CUC

CUP

CVE

CZK

DJF

DKK

DOP

DZD

EGP

ERN

ETB

EUR

FJD

FKP

GBP

GEL

GHS

GIP

GMD

GNF

GTQ

GYD

HKD

HNL

HRK

HTG

HUF

IDR

ILS

INR

IQD

IRR

ISK

JMD

JOD

JPY

KES

KGS

KHR

KMF

KPW

KRW

KWD

KYD

KZT

LAK

LBP

LKR

LRD

LSL

LYD

MAD

MDL

MGA

MKD

MMK

MNT

MOP

MRU

MUR

MVR

MWK

MXN

MXV

MYR

MZN

NAD

NGN

NIO

NOK

NPR

NZD

OMR

PAB

PEN

PGK

PHP

PKR

PLN

PYG

QAR

RON

RSD

RUB

RWF

SAR

SBD

SCR

SDG

SEK

SGD

SHP

SLE

SLL

SOS

SRD

SSP

STN

SVC

SYP

SZL

THB

TJS

TMT

TND

TOP

TRY

TTD

TWD

TZS

UAH

UGX

USD

USN

UYI

UYU

UYW

UZS

VED

VES

VND

VUV

WST

XAF

XAG

XAU

XBA

XBB

XBC

XBD

XCD

XDR

XOF

XPD

XPF

XPT

XSU

XTS

XUA

XXX

YER

ZAR

ZMW

ZWL

Implementations

impl Currency

pub fn numeric(self) -> u16

Returns the numeric code of the currency

This method will return the ISO 4217 numeric code of the currency

Example

use iso_currency::Currency;

assert_eq!(Currency::EUR.numeric(), 978);

pub fn name(&self) -> &str

Returns the name of the currency in English

This method will return the English name of the currency

Example

use iso_currency::Currency;

assert_eq!(Currency::EUR.name(), "Euro");

pub fn code(self) -> &'static str

Returns the ISO 4217 code

Example

use iso_currency::Currency;

assert_eq!(Currency::EUR.code(), "EUR");

pub fn used_by(self) -> Vec<Country>

Returns a list of locations which use the currency

This method will return a list of locations which use the currency. The use is non-exclusive, so it might mean that the location is using other currencies as well. The list of locations is sorted.

Example

use iso_currency::{Currency, Country};
 
assert_eq!(
    Currency::CHF.used_by(),
    vec![Country::LI, Country::CH]
);

pub fn symbol(self) -> CurrencySymbol

Returns the currency’s symbol

This method will return the symbol commonly used to represent the currency. In case there is no symbol associated the international currency symbol will be returned.

Example

use iso_currency::Currency;

assert_eq!(format!("{}", Currency::EUR.symbol()), "€");
assert_eq!(format!("{}", Currency::XXX.symbol()), "¤");

pub fn from_code(code: &str) -> Option<Currency>

Create a currency instance from a ISO 4217 character code

Example

use iso_currency::Currency;

assert_eq!(Currency::from_code("EUR"), Some(Currency::EUR));

pub fn from_numeric(numeric_code: u16) -> Option<Currency>

Create a currency instance from a ISO 4217 numeric code

Example

use iso_currency::Currency;

assert_eq!(Currency::from_numeric(978), Some(Currency::EUR));

pub fn exponent(self) -> Option<u16>

Returns the exponent of a currency (number of decimal places) For example, 1.00 Euro a 2 subunits so this will return Some(2) for EUR.

This returns an optional value because some currencies don’t have a subunit.

Example

use iso_currency::Currency;

assert_eq!(Currency::EUR.exponent(), Some(2));
assert_eq!(Currency::JPY.exponent(), Some(0));

pub fn subunit_fraction(self) -> Option<u16>

Returns how many of the subunits equal the main unit of the currency For example there are a 100 cents in 1 Euro so this will return Some(100) for EUR.

This returns an optional value because some currencies don’t have a subunit.

Example

use iso_currency::Currency;

assert_eq!(Currency::EUR.subunit_fraction(), Some(100));

Trait Implementations

impl Clone for Currency

fn clone(&self) -> Currency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Currency

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for Currency

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

Formats the value using the given formatter.

impl FromStr for Currency

type Err = ParseCurrencyError

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

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

type Iterator = CurrencyIter

fn iter() -> CurrencyIter

impl Ord for Currency

fn cmp(&self, other: &Currency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Currency> for Currency

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Currency> for Currency

fn partial_cmp(&self, other: &Currency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Currency

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

Serialize this value into the given Serde serializer.

impl Copy for Currency

impl Eq for Currency

impl StructuralEq for Currency

impl StructuralPartialEq for Currency