Skip to main content

MoneyAmount

Struct MoneyAmount 

Source
pub struct MoneyAmount(pub Decimal);
Expand description

A parsed monetary amount with decimal precision.

This type represents a non-negative decimal value parsed from a human-readable string. It preserves the original precision, which is important when converting to token amounts with specific decimal places.

§Precision

The scale method returns the number of decimal places, and mantissa returns the value as an integer. For example, "10.50" has scale 2 and mantissa 1050.

Tuple Fields§

§0: Decimal

Implementations§

Source§

impl MoneyAmount

Source

pub const fn scale(&self) -> u32

Returns the number of decimal places in the original input.

This is used to verify that the input precision doesn’t exceed the token’s decimal places.

Source

pub const fn mantissa(&self) -> u128

Returns the value as an unsigned integer (without decimal point).

For example, "12.34" returns 1234.

Source§

impl MoneyAmount

Source

pub fn parse(input: &str) -> Result<Self, MoneyAmountParseError>

Parses a human-readable currency string into a MoneyAmount.

Currency symbols, thousand separators, and whitespace are stripped before parsing. The result must be a non-negative number within the allowed range.

§Errors

Returns an error if:

  • The string cannot be parsed as a number
  • The value is negative
  • The value is outside the allowed range
Source§

impl MoneyAmount

Source

pub fn to_token_amount<T: ScaleFromMantissa>( self, decimals: u8, ) -> Result<T, MoneyAmountParseError>

Converts this amount to a token-specific integer scaled to the given decimal places.

This is the shared logic used by chain-specific token deployments (EVM, Solana) to convert human-readable amounts into on-chain token units.

§Errors

Returns an error if:

  • The input precision exceeds the token’s decimal places
  • The scaled value overflows the target type T

Trait Implementations§

Source§

impl Clone for MoneyAmount

Source§

fn clone(&self) -> MoneyAmount

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MoneyAmount

Source§

impl Debug for MoneyAmount

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for MoneyAmount

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MoneyAmount

Source§

impl From<u128> for MoneyAmount

Source§

fn from(value: u128) -> Self

Converts to this type from the input type.
Source§

impl FromStr for MoneyAmount

Source§

type Err = MoneyAmountParseError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for MoneyAmount

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MoneyAmount

Source§

impl TryFrom<&str> for MoneyAmount

Source§

type Error = MoneyAmountParseError

The type returned in the event of a conversion error.
Source§

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<f64> for MoneyAmount

Source§

type Error = MoneyAmountParseError

The type returned in the event of a conversion error.
Source§

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToCompactString for T
where T: Display,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more