dime

Types

Currency

opaque </>

pub opaque type Currency

CurrencyCodeError

</>

Types of errors that can be encountered when parsing a currency from it’s code (alpha or numeric).

pub type CurrencyCodeError {
  InvalidFormat
  UnrecognizedCode
}

Constructors

```
InvalidFormat
```
```
UnrecognizedCode
```

Constants

aed

</>

pub const aed: Currency

afn

</>

pub const afn: Currency

all

</>

pub const all: Currency

amd

</>

pub const amd: Currency

ang

</>

pub const ang: Currency

aoa

</>

pub const aoa: Currency

ars

</>

pub const ars: Currency

aud

</>

pub const aud: Currency

awg

</>

pub const awg: Currency

azn

</>

pub const azn: Currency

bam

</>

pub const bam: Currency

bbd

</>

pub const bbd: Currency

bdt

</>

pub const bdt: Currency

bgn

</>

pub const bgn: Currency

bhd

</>

pub const bhd: Currency

bif

</>

pub const bif: Currency

bmd

</>

pub const bmd: Currency

bnd

</>

pub const bnd: Currency

bob

</>

pub const bob: Currency

brl

</>

pub const brl: Currency

bsd

</>

pub const bsd: Currency

btn

</>

pub const btn: Currency

bwp

</>

pub const bwp: Currency

byn

</>

pub const byn: Currency

bzd

</>

pub const bzd: Currency

cad

</>

pub const cad: Currency

cdf

</>

pub const cdf: Currency

chf

</>

pub const chf: Currency

clp

</>

pub const clp: Currency

cny

</>

pub const cny: Currency

cop

</>

pub const cop: Currency

crc

</>

pub const crc: Currency

cuc

</>

pub const cuc: Currency

cup

</>

pub const cup: Currency

cve

</>

pub const cve: Currency

czk

</>

pub const czk: Currency

djf

</>

pub const djf: Currency

dkk

</>

pub const dkk: Currency

dop

</>

pub const dop: Currency

dzd

</>

pub const dzd: Currency

egp

</>

pub const egp: Currency

ern

</>

pub const ern: Currency

etb

</>

pub const etb: Currency

eur

</>

pub const eur: Currency

fjd

</>

pub const fjd: Currency

fkp

</>

pub const fkp: Currency

gbp

</>

pub const gbp: Currency

gel

</>

pub const gel: Currency

ghs

</>

pub const ghs: Currency

gip

</>

pub const gip: Currency

gmd

</>

pub const gmd: Currency

gnf

</>

pub const gnf: Currency

gtq

</>

pub const gtq: Currency

gyd

</>

pub const gyd: Currency

hkd

</>

pub const hkd: Currency

hnl

</>

pub const hnl: Currency

hrk

</>

pub const hrk: Currency

htg

</>

pub const htg: Currency

huf

</>

pub const huf: Currency

idr

</>

pub const idr: Currency

ils

</>

pub const ils: Currency

inr

</>

pub const inr: Currency

iqd

</>

pub const iqd: Currency

irr

</>

pub const irr: Currency

isk

</>

pub const isk: Currency

jmd

</>

pub const jmd: Currency

jod

</>

pub const jod: Currency

jpy

</>

pub const jpy: Currency

kes

</>

pub const kes: Currency

kgs

</>

pub const kgs: Currency

khr

</>

pub const khr: Currency

kmf

</>

pub const kmf: Currency

kpw

</>

pub const kpw: Currency

krw

</>

pub const krw: Currency

kwd

</>

pub const kwd: Currency

kyd

</>

pub const kyd: Currency

kzt

</>

pub const kzt: Currency

lak

</>

pub const lak: Currency

lbp

</>

pub const lbp: Currency

lkr

</>

pub const lkr: Currency

lrd

</>

pub const lrd: Currency

lsl

</>

pub const lsl: Currency

lyd

</>

pub const lyd: Currency

mad

</>

pub const mad: Currency

mdl

</>

pub const mdl: Currency

mga

</>

pub const mga: Currency

mkd

</>

pub const mkd: Currency

mmk

</>

pub const mmk: Currency

mnt

</>

pub const mnt: Currency

mop

</>

pub const mop: Currency

mru

</>

pub const mru: Currency

mur

</>

pub const mur: Currency

mvr

</>

pub const mvr: Currency

mwk

</>

pub const mwk: Currency

mxn

</>

pub const mxn: Currency

myr

</>

pub const myr: Currency

mzn

</>

pub const mzn: Currency

nad

</>

pub const nad: Currency

ngn

</>

pub const ngn: Currency

nio

</>

pub const nio: Currency

nok

</>

pub const nok: Currency

npr

</>

pub const npr: Currency

nzd

</>

pub const nzd: Currency

omr

</>

pub const omr: Currency

pab

</>

pub const pab: Currency

pen

</>

pub const pen: Currency

pgk

</>

pub const pgk: Currency

php

</>

pub const php: Currency

pkr

</>

pub const pkr: Currency

pln

</>

pub const pln: Currency

pyg

</>

pub const pyg: Currency

qar

</>

pub const qar: Currency

ron

</>

pub const ron: Currency

rsd

</>

pub const rsd: Currency

rub

</>

pub const rub: Currency

rwf

</>

pub const rwf: Currency

sar

</>

pub const sar: Currency

sbd

</>

pub const sbd: Currency

scr

</>

pub const scr: Currency

sdg

</>

pub const sdg: Currency

sek

</>

pub const sek: Currency

sgd

</>

pub const sgd: Currency

shp

</>

pub const shp: Currency

sle

</>

pub const sle: Currency

sos

</>

pub const sos: Currency

srd

</>

pub const srd: Currency

ssp

</>

pub const ssp: Currency

stn

</>

pub const stn: Currency

svc

</>

pub const svc: Currency

syp

</>

pub const syp: Currency

szl

</>

pub const szl: Currency

thb

</>

pub const thb: Currency

tjs

</>

pub const tjs: Currency

tmt

</>

pub const tmt: Currency

tnd

</>

pub const tnd: Currency

top

</>

pub const top: Currency

try

</>

pub const try: Currency

ttd

</>

pub const ttd: Currency

twd

</>

pub const twd: Currency

tzs

</>

pub const tzs: Currency

uah

</>

pub const uah: Currency

ugx

</>

pub const ugx: Currency

usd

</>

pub const usd: Currency

uyu

</>

pub const uyu: Currency

uyw

</>

pub const uyw: Currency

uzs

</>

pub const uzs: Currency

ved

</>

pub const ved: Currency

ves

</>

pub const ves: Currency

vnd

</>

pub const vnd: Currency

vuv

</>

pub const vuv: Currency

wst

</>

pub const wst: Currency

xaf

</>

pub const xaf: Currency

xcd

</>

pub const xcd: Currency

xof

</>

pub const xof: Currency

xpf

</>

pub const xpf: Currency

yer

</>

pub const yer: Currency

zar

</>

pub const zar: Currency

zmw

</>

pub const zmw: Currency

zwg

</>

pub const zwg: Currency

Functions

alpha_code

</>

pub fn alpha_code(currency: Currency) -> String

Get the 3 character alphabetic code for the currency.

display_name

</>

pub fn display_name(currency: Currency) -> String

Get the display name of the currency in English.

from_alpha_code

</>

pub fn from_alpha_code(
  currency_code: String,
) -> Result(Currency, CurrencyCodeError)

Try and retrieve a currency by it’s 3 character alphabetic code.

from_numeric_code

</>

pub fn from_numeric_code(
  currency_code: String,
) -> Result(Currency, CurrencyCodeError)

Try and retrieve a currency by it’s 3 character numeric code.

known_currencies

</>

pub fn known_currencies() -> List(Currency)

Retrieve the list of all the currencies known to this library.

minor_units

</>

pub fn minor_units(currency: Currency) -> Int

The decimal relationship between the currency and it’s minor unit, e.g. euro and euro cent.

1, 2 and 3 signify a ratio of 10:1, 100:1 and 1000:1 respectively.

numeric_code

</>

pub fn numeric_code(currency: Currency) -> String

Get the 3 character numeric code for the currency.

symbol

</>

pub fn symbol(currency: Currency) -> String

Get the graphical symbol used as a shorthand representation of the specific currency unit.