Struct Quantity 

pub struct Quantity(pub D128);

A type-safe quantity wrapper for financial instruments.

Example

use clob_sync::order::Quantity;

let qty = Quantity::try_from("100.5").unwrap();
assert!(!qty.is_zero());

Tuple Fields

0: D128

Implementations

impl Quantity

pub fn new(value: f64) -> Quantity

Creates a new Quantity from an f64 value.

pub fn reduced_by(&self, quantity: &Quantity) -> Quantity

Returns a new Quantity reduced by the specified amount.

Example

use clob_sync::order::Quantity;

let qty = Quantity::try_from("100.0").unwrap();
let reduced = qty.reduced_by(&Quantity::try_from("30.0").unwrap());
assert_eq!(reduced, Quantity::try_from("70.0").unwrap());

pub fn reduce_by(&mut self, quantity: &Quantity)

Reduces this quantity in place by the specified amount.

Example

use clob_sync::order::Quantity;

let mut qty = Quantity::try_from("100.0").unwrap();
qty.reduce_by(&Quantity::try_from("30.0").unwrap());
assert_eq!(qty, Quantity::try_from("70.0").unwrap());

pub fn clear(&mut self)

Sets the quantity to zero.

Example

use clob_sync::order::Quantity;

let mut qty = Quantity::new(100.0);
qty.clear();
assert!(qty.is_zero());

pub fn is_zero(&self) -> bool

Returns true if the quantity is zero.

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, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<f32> for Quantity

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<u128> for Quantity

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Quantity

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Quantity

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Quantity

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Quantity

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Quantity

fn from(value: usize) -> Self

Converts to this type from the input type.

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 TryFrom<&str> for Quantity

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Quantity

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Quantity

impl Eq for Quantity

impl StructuralPartialEq for Quantity