Struct Currency 

#[repr(C)]
pub struct Currency {
    pub code: Ustr,
    pub precision: u8,
    pub iso4217: u16,
    pub name: Ustr,
    pub currency_type: CurrencyType,
}

Represents a medium of exchange in a specified denomination with a fixed decimal precision.

Handles up to FIXED_PRECISION decimals of precision.

Fields

code: Ustr

The currency code as an alpha-3 string (e.g., “USD”, “EUR”).

precision: u8

The currency decimal precision.

iso4217: u16

The ISO 4217 currency code.

name: Ustr

The full name of the currency.

currency_type: CurrencyType

The currency type, indicating its category (e.g. Fiat, Crypto).

Implementations

impl Currency

pub fn AUD() -> Self

Returns the Australian dollar (AUD) currency.

pub fn BRL() -> Self

Returns the Brazilian real (BRL) currency.

pub fn CAD() -> Self

Returns the Canadian dollar (CAD) currency.

pub fn CHF() -> Self

Returns the Swiss franc (CHF) currency.

pub fn CNY() -> Self

Returns the Chinese yuan (CNY) currency.

pub fn CNH() -> Self

Returns the Chinese yuan (offshore) (CNH) currency.

pub fn CZK() -> Self

Returns the Czech koruna (CZK) currency.

pub fn DKK() -> Self

Returns the Danish krone (DKK) currency.

pub fn EUR() -> Self

Returns the Euro (EUR) currency.

pub fn GBP() -> Self

Returns the British Pound (GBP) currency.

pub fn HKD() -> Self

Returns the Hong Kong dollar (HKD) currency.

pub fn HUF() -> Self

Returns the Hungarian forint (HUF) currency.

pub fn ILS() -> Self

Returns the Israeli new shekel (ILS) currency.

pub fn INR() -> Self

Returns the Indian rupee (INR) currency.

pub fn JPY() -> Self

Returns the Japanese yen (JPY) currency.

pub fn KRW() -> Self

Returns the South Korean won (KRW) currency.

pub fn MXN() -> Self

Returns the Mexican peso (MXN) currency.

pub fn NOK() -> Self

Returns the Norwegian krone (NOK) currency.

pub fn NZD() -> Self

Returns the New Zealand dollar (NZD) currency.

pub fn PLN() -> Self

Returns the Polish złoty (PLN) currency.

pub fn RUB() -> Self

Returns the Russian ruble (RUB) currency.

pub fn SAR() -> Self

Returns the Saudi riyal (SAR) currency.

pub fn SEK() -> Self

Returns the Swedish krona (SEK) currency.

pub fn SGD() -> Self

Returns the Singapore dollar (SGD) currency.

pub fn THB() -> Self

Returns the Thai baht (THB) currency.

pub fn TRY() -> Self

Returns the Turkish lira (TRY) currency.

pub fn TWD() -> Self

Returns the New Taiwan dollar (TWD) currency.

pub fn USD() -> Self

Returns the United States dollar (USD) currency.

pub fn ZAR() -> Self

Returns the South African rand (ZAR) currency.

pub fn XAG() -> Self

Returns the Silver (one troy ounce) (XAG) currency.

pub fn XAU() -> Self

Returns the Gold (one troy ounce) (XAU) currency.

pub fn XPT() -> Self

Returns the Platinum (one troy ounce) (XPT) currency.

pub fn ONEINCH() -> Self

Returns the 1inch Network (1INCH) currency.

pub fn AAVE() -> Self

Returns the Aave (AAVE) currency.

pub fn ACA() -> Self

Returns the Acala Token (ACA) currency.

pub fn ADA() -> Self

Returns the Cardano (ADA) currency.

pub fn APT() -> Self

Returns the Aptos (APT) currency.

pub fn ARB() -> Self

Returns the Arbitrum (ARB) currency.

pub fn AVAX() -> Self

Returns the Avalanche (AVAX) currency.

pub fn BCH() -> Self

Returns the Bitcoin Cash (BCH) currency.

pub fn BIO() -> Self

Returns the BioPassport (BIO) currency.

pub fn BTC() -> Self

Returns the Bitcoin (BTC) currency.

pub fn BTTC() -> Self

Returns the BitTorrent (BTTC) currency.

pub fn BNB() -> Self

Returns the Binance Coin (BNB) currency.

pub fn BRZ() -> Self

Returns the Brazilian Digital Token (BRZ) currency.

pub fn BSV() -> Self

Returns the Bitcoin SV (BSV) currency.

pub fn BUSD() -> Self

Returns the Binance USD (BUSD) currency.

pub fn CAKE() -> Self

Returns the PancakeSwap (CAKE) currency.

pub fn CRV() -> Self

Returns the Curve DAO Token (CRV) currency.

pub fn DASH() -> Self

Returns the Dash (DASH) currency.

pub fn DOT() -> Self

Returns the Polkadot (DOT) currency.

pub fn DOGE() -> Self

Returns the Dogecoin (DOGE) currency.

pub fn ENA() -> Self

Returns the Ethena (ENA) currency.

pub fn EOS() -> Self

Returns the EOS (EOS) currency.

pub fn ETH() -> Self

Returns the Ethereum (ETH) currency.

pub fn ETHW() -> Self

Returns the EthereumPoW (ETHW) currency.

pub fn FDUSD() -> Self

Returns the First Digital USD (FDUSD) currency.

pub fn GWEI() -> Self

Returns the Gwei (GWEI) currency.

pub fn HYPE() -> Self

Returns the Hyperliquid (HYPE) currency.

pub fn JOE() -> Self

Returns the JOE (JOE) currency.

pub fn LINK() -> Self

Returns the Chainlink (LINK) currency.

pub fn LTC() -> Self

Returns the Litecoin (LTC) currency.

pub fn LUNA() -> Self

Returns the Terra (LUNA) currency.

pub fn MAMUSD() -> Self

Returns the MAMUSD (MAMUSD) currency.

pub fn NBT() -> Self

Returns the NanoByte Token (NBT) currency.

pub fn POL() -> Self

Returns the Polygon (POL) currency.

pub fn PROVE() -> Self

Returns the Prove AI (PROVE) currency.

pub fn RLUSD() -> Self

Returns the Ripple USD (RLUSD) currency.

pub fn SOL() -> Self

Returns the Solana (SOL) currency.

pub fn SHIB() -> Self

Returns the Shiba Inu (SHIB) currency.

pub fn SUI() -> Self

Returns the Sui (SUI) currency.

pub fn TON() -> Self

Returns the Toncoin (TON) currency.

pub fn TRX() -> Self

Returns the TRON (TRX) currency.

pub fn TRYB() -> Self

Returns the BiLira (TRYB) currency.

pub fn TUSD() -> Self

Returns the TrueUSD (TUSD) currency.

pub fn UNI() -> Self

Returns the Uniswap (UNI) currency.

pub fn VTC() -> Self

Returns the Vertcoin (VTC) currency.

pub fn WBTC() -> Self

Returns the Wrapped Bitcoin (WBTC) currency.

pub fn WSB() -> Self

Returns the WallStreetBets DApp (WSB) currency.

pub fn XBT() -> Self

Returns the Bitcoin (XBT) currency.

pub fn XEC() -> Self

Returns the eCash (XEC) currency.

pub fn XLM() -> Self

Returns the Stellar Lumen (XLM) currency.

pub fn XMR() -> Self

Returns the Monero (XMR) currency.

pub fn USDT() -> Self

Returns the Tether (USDT) currency.

pub fn XRP() -> Self

Returns the XRP (XRP) currency.

pub fn XTZ() -> Self

Returns the Tezos (XTZ) currency.

pub fn USDC() -> Self

Returns the USD Coin (USDC) currency.

pub fn USDC_POS() -> Self

Returns the USD Coin (PoS) (USDC.e) currency.

pub fn USDG() -> Self

Returns the Global Dollar (USDG) currency.

pub fn USDP() -> Self

Returns the Pax Dollar (USDP) currency.

pub fn pUSD() -> Self

Returns the Polymarket USD (pUSD) currency.

pub fn ZEC() -> Self

Returns the Zcash (ZEC) currency.

impl Currency

pub fn new_checked<T: AsRef<str>>( code: T, precision: u8, iso4217: u16, name: T, currency_type: CurrencyType, ) -> CorrectnessResult<Self>

Creates a new Currency instance with correctness checking.

Errors

Returns an error if:

• code is not a valid string.
• name is the empty string.
• precision is invalid outside the valid representable range [0, FIXED_PRECISION].

Notes

PyO3 requires a Result type for proper error handling and stacktrace printing in Python.

pub fn new<T: AsRef<str>>( code: T, precision: u8, iso4217: u16, name: T, currency_type: CurrencyType, ) -> Self

Creates a new Currency instance.

Panics

Panics if a correctness check fails. See Currency::new_checked for more details.

pub fn register(currency: Self, overwrite: bool) -> CorrectnessResult<()>

Register the given currency in the internal currency map.

• If overwrite is true, any existing currency will be replaced.
• If overwrite is false and the currency already exists, the operation is a no-op.

Errors

This function does not currently return an error.

pub fn try_from_str(s: &str) -> Option<Self>

Attempts to parse a Currency from a string, returning None if not found.

pub fn is_fiat(code: &str) -> Result<bool, CurrencyLookupError>

Checks if the currency identified by the given code is a fiat currency.

Errors

Returns an error if a currency with the given code does not exist.

pub fn is_crypto(code: &str) -> Result<bool, CurrencyLookupError>

Checks if the currency identified by the given code is a cryptocurrency.

Errors

Returns an error if a currency with the given code does not exist.

pub fn is_commodity_backed(code: &str) -> Result<bool, CurrencyLookupError>

Checks if the currency identified by the given code is a commodity (such as a precious metal).

Errors

Returns an error if a currency with the given code does not exist.

pub fn get_or_create_crypto<T: AsRef<str>>(code: T) -> Self

Returns a currency from the internal map or creates a new crypto currency if not found.

This is a convenience method for adapters that need to handle unknown currencies (e.g., newly listed assets on exchanges). If the currency code is not found in the internal map, a new cryptocurrency is created with:

• 8 decimal precision
• ISO 4217 code of 0
• CurrencyType::Crypto

The newly created currency is automatically registered in the internal map.

pub fn get_or_create_crypto_with_context<T: AsRef<str>>( code: T, context: Option<&str>, ) -> Self

Gets or creates a cryptocurrency with context logging.

This is a convenience wrapper around Currency::get_or_create_crypto that:

• Trims whitespace from the currency code
• Handles empty strings with a fallback to USDT
• Provides optional context for logging

Used by exchange adapters for consistent currency handling across parsing operations.

Arguments

• code - The currency code (will be trimmed)
• context - Optional context for logging (e.g., “balance detail”, “instrument”)

Trait Implementations

impl Clone for Currency

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Currency

impl Debug for Currency

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

Formats the value using the given formatter.

impl DerefToPyAny for Currency

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

impl<T: AsRef<str>> From<T> for Currency

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a, 'py> FromPyObject<'a, 'py> for Currency

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl FromStr for Currency

type Err = CurrencyLookupError

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<'py> IntoPyObject<'py> for Currency

type Target = Currency

The Python output type

type Output = Bound<'py, <Currency as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for Currency

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for Currency

const NAME: &str = "Currency"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for Currency

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents a medium of exchange in a specified denomination with a fixed decimal precision. /// /// Handles up to [`FIXED_PRECISION`] decimals of precision.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<Currency as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<Currency>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForCurrency

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for Currency

const TEXT_SIGNATURE: &'static str = "(code, precision, iso4217, name, currency_type)"

impl PyStubType for Currency

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for Currency

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

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.