Struct Price 

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

Price per one instrument unit.

Can be negative in certain derivative markets (e.g., options, futures with storage costs, calendar spreads).

Implementations

impl Price

pub const ZERO: Self

Zero value.

pub fn new(value: Decimal) -> Self

Creates a new value from a rust_decimal::Decimal.

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.

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

Creates a value from a string representation.

Examples

let price = Price::from_str("42350.75")?;
assert_eq!(price.to_string(), "42350.75");

let negative_price = Price::from_str("-10.5")?;
assert_eq!(negative_price.to_string(), "-10.5");

Errors

Returns Error::InvalidFormat when string cannot be parsed.

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.

Errors

Returns Error::InvalidFormat when string cannot be parsed.

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.

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

This method is infallible for signed types as rounding cannot produce errors.

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::Overflow on overflow or underflow.

pub fn checked_neg(self) -> Result<Self, Error>

Safely negates the value.

Errors

Returns Error::Overflow if negation would overflow.

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

Safely multiplies by an i64 scalar.

Errors

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::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::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::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::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::Overflow on overflow.

impl Price

pub fn calculate_volume(self, quantity: Quantity) -> Result<Volume, Error>

Calculates volume from price and quantity.

Uses absolute values of both price and quantity to ensure volume is non-negative.

Errors

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

Trait Implementations

impl Clone for Price

fn clone(&self) -> Price

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Price

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

Formats the value using the given formatter.

impl Display for Price

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

Formats the value using the given formatter.

impl Hash for Price

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 Price

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

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

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

impl Eq for Price

impl StructuralPartialEq for Price