Struct Quantity 

pub struct Quantity(/* private fields */);

Quantity of an instrument.

Implementations

impl Quantity

pub const ZERO: Self

Zero value.

pub fn new(value: Decimal) -> Result<Self, Error>

Creates a new value from a rust_decimal::Decimal.

Errors

Returns Error::Negative when value is below zero.

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

Creates a value from a 64-bit floating-point number.

Errors

Returns Error::InvalidFloat when value is NaN or infinite. Returns Error::Negative when value is negative.

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

Creates a value from a string representation.

Examples

let qty = Quantity::from_str("123.45")?;
assert_eq!(qty.to_string(), "123.45");

Errors

Returns Error::InvalidFormat when string cannot be parsed. Returns Error::Negative when parsed value is negative.

pub fn from_str_rounded( s: &str, scale: u32, rounding: RoundingStrategy, ) -> Result<Self, Error>

Creates a value from a string representation with rounding.

The value is rounded to the specified scale using the provided rounding strategy.

Examples

let qty = Quantity::from_str_rounded(
    "123.123456789",
    8,
    RoundingStrategy::DEFAULT
)?;
assert_eq!(qty.to_string(), "123.12345679");

// Conservative profit
let qty = Quantity::from_str_rounded(
    "123.125",
    2,
    RoundingStrategy::CONSERVATIVE_PROFIT
)?;
assert_eq!(qty.to_string(), "123.12");

Errors

Returns Error::InvalidFormat when string cannot be parsed. Returns Error::Negative when parsed value is negative after rounding.

pub fn from_f64_rounded( value: f64, scale: u32, rounding: RoundingStrategy, ) -> Result<Self, Error>

Creates a value from a 64-bit floating-point number with rounding.

The value is rounded to the specified scale using the provided rounding strategy.

Errors

Returns Error::InvalidFloat when value is NaN or infinite. Returns Error::Negative when value is negative after rounding.

pub fn from_decimal_rounded( decimal: Decimal, scale: u32, rounding: RoundingStrategy, ) -> Result<Self, Error>

Creates a value from a rust_decimal::Decimal with rounding.

The value is rounded to the specified scale using the provided rounding strategy.

Errors

Returns Error::Negative when value is negative after rounding.

pub fn to_decimal(&self) -> Decimal

Returns the underlying decimal value.

pub fn is_zero(&self) -> bool

Returns true when the value is exactly zero.

pub fn checked_add(self, other: Self) -> Result<Self, Error>

Safely adds two values.

Errors

Returns Error::Overflow on overflow.

pub fn checked_sub(self, other: Self) -> Result<Self, Error>

Safely subtracts two values.

Errors

Returns Error::Underflow when result would be negative.

pub fn checked_mul_i64(self, scalar: i64) -> Result<Self, Error>

Safely multiplies by an i64 scalar.

Errors

Returns Error::Negative when scalar is negative. Returns Error::Overflow on overflow.

pub fn checked_mul_u64(self, scalar: u64) -> Result<Self, Error>

Safely multiplies by a u64 scalar.

Errors

Returns Error::Overflow on overflow.

pub fn checked_mul_f64(self, factor: f64) -> Result<Self, Error>

Safely multiplies by an f64 factor.

Errors

Returns Error::InvalidFloat when factor is NaN or infinite. Returns Error::Negative when factor is negative. Returns Error::Overflow on overflow.

pub fn checked_div_i64(self, divisor: i64) -> Result<Self, Error>

Safely divides by an i64 divisor.

Errors

Returns Error::DivisionByZero when divisor is zero. Returns Error::Negative when divisor is negative. Returns Error::Overflow on overflow.

pub fn checked_div_u64(self, divisor: u64) -> Result<Self, Error>

Safely divides by a u64 divisor.

Errors

Returns Error::DivisionByZero when divisor is zero. Returns Error::Overflow on overflow.

pub fn checked_div_f64(self, divisor: f64) -> Result<Self, Error>

Safely divides by an f64 divisor.

Errors

Returns Error::InvalidFloat when divisor is NaN or infinite. Returns Error::DivisionByZero when divisor is zero. Returns Error::Negative when divisor is negative. Returns Error::Overflow on overflow.

pub fn checked_rem_i64(self, divisor: i64) -> Result<Self, Error>

Safely computes remainder by i64 divisor.

Errors

Returns Error::DivisionByZero when divisor is zero. Returns Error::Negative when divisor is negative. Returns Error::Overflow on overflow.

pub fn checked_rem_u64(self, divisor: u64) -> Result<Self, Error>

Safely computes remainder by u64 divisor.

Errors

Returns Error::DivisionByZero when divisor is zero. Returns Error::Overflow on overflow.

pub fn checked_rem_f64(self, divisor: f64) -> Result<Self, Error>

Safely computes remainder by f64 divisor.

Errors

Returns Error::InvalidFloat when divisor is NaN or infinite. Returns Error::DivisionByZero when divisor is zero. Returns Error::Negative when divisor is negative. Returns Error::Overflow on overflow.

impl Quantity

pub fn calculate_volume(self, price: Price) -> Result<Volume, Error>

Calculates volume from quantity and price.

Delegates to Price::calculate_volume for the actual computation.

Errors

Returns Error::Overflow with ParamKind::Price if multiplication overflows.

Trait Implementations

impl Clone for Quantity

fn clone(&self) -> Quantity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Quantity

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

Formats the value using the given formatter.

impl Display for Quantity

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

Formats the value using the given formatter.

impl Hash for Quantity

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 Ord for Quantity

fn cmp(&self, other: &Quantity) -> 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 Quantity

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

fn partial_cmp(&self, other: &Quantity) -> 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 Copy for Quantity

impl Eq for Quantity

impl StructuralPartialEq for Quantity