Crate currencies

💰 currencies

This crate allows for generic manipulation of currencies (both real-world and cryptocurrencies) via the Amount struct and the Currency trait.

The Amount struct is able to represent arbitrary amounts of any supported Currency with the ability to restrict the underlying currencies at compile-time to only allow checked arithmetic operations and requires consuming an Option in all fallible circumstances.

Re-exports

• pub use amount::Amount;
• pub use amount::Backing;
• pub use currency::Currency;

Modules

• amount
  Home of the Amount struct and supporting types and impls.
• currency
  Home of the Currency trait, all built-in currencies such as USD, AAVE, ETH, etc., the define_currency! macro, and related/supporting types.
• safety
  Home of the Safety sealed type and its two variants Checked and Unchecked.
• serde_integration
  Contains impls for serde integration

Macros

• define_currency
  Shorthand for defining a new Currency. All ISO-4217 currencies already have an entry.

Structs

• ParsedAmount
  Represents an Amount that has been parsed from a string representation. Includes Span information.
• U256
  Wraps primitive_types::U256 enhancing it with some extra trait impls needed for currency manipulation.