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

pub fn BRL() -> Self

pub fn CAD() -> Self

pub fn CHF() -> Self

pub fn CNY() -> Self

pub fn CNH() -> Self

pub fn CZK() -> Self

pub fn DKK() -> Self

pub fn EUR() -> Self

pub fn GBP() -> Self

pub fn HKD() -> Self

pub fn HUF() -> Self

pub fn ILS() -> Self

pub fn INR() -> Self

pub fn JPY() -> Self

pub fn KRW() -> Self

pub fn MXN() -> Self

pub fn NOK() -> Self

pub fn NZD() -> Self

pub fn PLN() -> Self

pub fn RUB() -> Self

pub fn SAR() -> Self

pub fn SEK() -> Self

pub fn SGD() -> Self

pub fn THB() -> Self

pub fn TRY() -> Self

pub fn TWD() -> Self

pub fn USD() -> Self

pub fn ZAR() -> Self

pub fn XAG() -> Self

pub fn XAU() -> Self

pub fn XPT() -> Self

pub fn ONEINCH() -> Self

pub fn AAVE() -> Self

pub fn ACA() -> Self

pub fn ADA() -> Self

pub fn AVAX() -> Self

pub fn BCH() -> Self

pub fn BTC() -> Self

pub fn BTTC() -> Self

pub fn BNB() -> Self

pub fn BRZ() -> Self

pub fn BSV() -> Self

pub fn BUSD() -> Self

pub fn CAKE() -> Self

pub fn DASH() -> Self

pub fn DOT() -> Self

pub fn DOGE() -> Self

pub fn EOS() -> Self

pub fn ETH() -> Self

pub fn ETHW() -> Self

pub fn FDUSD() -> Self

pub fn JOE() -> Self

pub fn LINK() -> Self

pub fn LTC() -> Self

pub fn LUNA() -> Self

pub fn NBT() -> Self

pub fn SOL() -> Self

pub fn SHIB() -> Self

pub fn TRX() -> Self

pub fn TRYB() -> Self

pub fn TUSD() -> Self

pub fn VTC() -> Self

pub fn WSB() -> Self

pub fn XBT() -> Self

pub fn XEC() -> Self

pub fn XLM() -> Self

pub fn XMR() -> Self

pub fn USDT() -> Self

pub fn XRP() -> Self

pub fn XTZ() -> Self

pub fn USDC() -> Self

pub fn USDC_POS() -> Self

pub fn USDP() -> Self

pub fn ZEC() -> Self

impl Currency

pub fn new_checked<T: AsRef<str>>( code: T, precision: u8, iso4217: u16, name: T, currency_type: CurrencyType, ) -> Result<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) -> Result<()>

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

Returns an error if there is a failure acquiring the lock on the currency map.

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>

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.
• There is a failure acquiring the lock on the currency map.

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

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

Errors

Returns an error if:

• If a currency with the given code does not exist.
• If there is a failure acquiring the lock on the currency map.

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

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.
• There is a failure acquiring the lock on the currency map.

Trait Implementations

impl Clone for Currency

fn clone(&self) -> Currency

Returns a duplicate 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<T: AsRef<str>> From<T> for Currency

fn from(value: T) -> Self

Converts to this type from the input type.

impl FromStr for Currency

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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 IntoPy<Py<PyAny>> for Currency

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

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

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Currency

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Currency>

This handles following two situations:

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

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Currency> for PyClassImplCollector<Currency>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a Currency

type Holder = Option<PyRef<'py, Currency>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut Currency

type Holder = Option<PyRefMut<'py, Currency>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Currency> for PyClassImplCollector<Currency>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Currency

const NAME: &'static str = "Currency"

Class name.

const MODULE: Option<&'static str>

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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

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

impl Eq for Currency