Struct Amount 

pub struct Amount(pub Decimal);

Amount type (zero-cost wrapper).

Represents the quantity of an asset using Decimal for precision. Provides type safety via the newtype pattern.

Tuple Fields

0: Decimal

Implementations

impl Amount

pub fn new(value: Decimal) -> Amount

Creates a new amount instance.

Examples

use ccxt_core::types::financial::Amount;
use rust_decimal_macros::dec;

let amount = Amount::new(dec!(0.1));

pub fn as_decimal(&self) -> Decimal

Returns the inner Decimal value.

pub fn parse(s: &str) -> Result<Amount, Error>

Parses an amount from a string.

Errors

Returns an error if the string cannot be parsed as a valid Decimal.

pub fn is_zero(&self) -> bool

Returns true if the amount is zero.

pub fn is_positive(&self) -> bool

Returns true if the amount is positive (greater than zero).

pub fn abs(&self) -> Amount

Returns the absolute value of the amount.

impl Amount

pub const ZERO: Amount

Zero amount constant.

pub fn gt(&self, other: Decimal) -> bool

Checks if the amount is greater than the given Decimal value.

pub fn lt(&self, other: Decimal) -> bool

Checks if the amount is less than the given Decimal value.

pub fn ge(&self, other: Decimal) -> bool

Checks if the amount is greater than or equal to the given Decimal value.

pub fn le(&self, other: Decimal) -> bool

Checks if the amount is less than or equal to the given Decimal value.

Trait Implementations

impl Add for Amount

Amount + Amount = Amount

type Output = Amount

The resulting type after applying the + operator.

fn add(self, rhs: Amount) -> <Amount as Add>::Output

Performs the + operation.

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Amount

fn deserialize<__D>( __deserializer: __D, ) -> Result<Amount, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Formats the value using the given formatter.

impl Div<Amount> for Cost

Cost ÷ Amount = Price

Derives price from total cost and amount.

type Output = Price

The resulting type after applying the / operator.

fn div(self, rhs: Amount) -> <Cost as Div<Amount>>::Output

Performs the / operation.

impl Div<Decimal> for Amount

Amount ÷ Decimal = Amount (scalar division)

Used for dividing amounts by a factor.

type Output = Amount

The resulting type after applying the / operator.

fn div(self, rhs: Decimal) -> <Amount as Div<Decimal>>::Output

Performs the / operation.

impl Div for Amount

Amount ÷ Amount = Decimal (amount ratio)

type Output = Decimal

The resulting type after applying the / operator.

fn div(self, rhs: Amount) -> <Amount as Div>::Output

Performs the / operation.

impl From<Amount> for Decimal

fn from(amount: Amount) -> Decimal

Converts to this type from the input type.

impl From<Decimal> for Amount

fn from(value: Decimal) -> Amount

Converts to this type from the input type.

impl FromStr for Amount

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Amount, <Amount as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Amount

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Mul<Amount> for Decimal

Decimal × Amount = Amount (scalar multiplication commutativity)

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, rhs: Amount) -> <Decimal as Mul<Amount>>::Output

Performs the * operation.

impl Mul<Amount> for Price

Price × Amount = Cost

This is the most fundamental relationship in financial calculations: price times amount equals cost. Enforces this constraint through the type system to prevent unit errors.

type Output = Cost

The resulting type after applying the * operator.

fn mul(self, rhs: Amount) -> <Price as Mul<Amount>>::Output

Performs the * operation.

impl Mul<Decimal> for Amount

Amount × Decimal = Amount (scalar multiplication)

Used for multiplying amounts by a factor.

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, rhs: Decimal) -> <Amount as Mul<Decimal>>::Output

Performs the * operation.

impl Mul<Price> for Amount

Amount × Price = Cost (multiplication commutativity)

type Output = Cost

The resulting type after applying the * operator.

fn mul(self, rhs: Price) -> <Amount as Mul<Price>>::Output

Performs the * operation.

impl Ord for Amount

fn cmp(&self, other: &Amount) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Amount

fn eq(&self, other: &Amount) -> 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 PartialOrd for Amount

fn partial_cmp(&self, other: &Amount) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Amount

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Amount

Amount - Amount = Amount

type Output = Amount

The resulting type after applying the - operator.

fn sub(self, rhs: Amount) -> <Amount as Sub>::Output

Performs the - operation.

impl<'a> Sum<&'a Amount> for Amount

Enables using .sum() on &Amount iterators.

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = &'a Amount>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Amount

Enables using .sum() on Amount iterators.

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = Amount>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount