Struct Quantity

#[repr(C)]
pub struct Quantity {
    pub raw: QuantityRaw,
    pub precision: u8,
}

Represents a quantity with a non-negative value.

Capable of storing either a whole number (no decimal places) of ‘contracts’ or ‘shares’ (instruments denominated in whole units) or a decimal value containing decimal places for instruments denominated in fractional units.

Handles up to {FIXED_PRECISION} decimals of precision.

• QUANTITY_MAX = {QUANTITY_MAX}
• QUANTITY_MIN = 0

Fields

raw: QuantityRaw

Represents the raw fixed-point value, with precision defining the number of decimal places.

precision: u8

The number of decimal places, with a maximum of {FIXED_PRECISION}.

Implementations

impl Quantity

pub fn new_checked(value: f64, precision: u8) -> Result<Self>

Creates a new Quantity instance with correctness checking.

Errors

This function returns an error:

• If value is invalid outside the representable range [0, {QUANTITY_MAX}].
• If precision is invalid outside the representable range [0, {FIXED_PRECISION}].

Notes

PyO3 requires a Result type for proper error handling and stacktrace printing in Python.

pub fn non_zero_checked(value: f64, precision: u8) -> Result<Self>

Creates a new Quantity instance with a guaranteed non zero value.

Errors

This function returns an error:

• If value is zero.
• If value becomes zero after rounding to precision.
• If value is invalid outside the representable range [0, {QUANTITY_MAX}].
• If precision is invalid outside the representable range [0, {FIXED_PRECISION}].

Notes

PyO3 requires a Result type for proper error handling and stacktrace printing in Python.

pub fn new(value: f64, precision: u8) -> Self

Creates a new Quantity instance.

Panics

This function panics:

• If a correctness check fails. See Quantity::new_checked for more details.

pub fn non_zero(value: f64, precision: u8) -> Self

Creates a new Quantity instance with a guaranteed non zero value.

Panics

This function panics:

• If a correctness check fails. See Quantity::non_zero_checked for more details.

pub fn from_raw(raw: QuantityRaw, precision: u8) -> Self

Creates a new Quantity instance from the given raw fixed-point value and precision.

Panics

This function panics:

• If a correctness check fails. See Quantity::new_checked for more details.

pub fn zero(precision: u8) -> Self

Creates a new Quantity instance with a value of zero with the given precision.

Panics

This function panics:

• If a correctness check fails. See Quantity::new_checked for more details.

pub fn is_undefined(&self) -> bool

Returns true if the value of this instance is undefined.

pub fn is_zero(&self) -> bool

Returns true if the value of this instance is zero.

pub fn is_positive(&self) -> bool

Returns true if the value of this instance is position (> 0).

pub fn as_f64(&self) -> f64

Returns the value of this instance as an f64.

pub fn as_decimal(&self) -> Decimal

Returns the value of this instance as a Decimal.

pub fn to_formatted_string(&self) -> String

Returns a formatted string representation of this instance.

Trait Implementations

impl Add for Quantity

type Output = Quantity

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T: Into<QuantityRaw>> AddAssign<T> for Quantity

fn add_assign(&mut self, other: T)

Performs the += operation.

impl Clone for Quantity

fn clone(&self) -> Quantity

Returns a copy 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 Default for Quantity

fn default() -> Quantity

Returns the “default value” for a type.

impl Deref for Quantity

type Target = u128

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Quantity

fn deserialize<D>(_deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Quantity

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

Formats the value using the given formatter.

impl From<&Quantity> for f64

fn from(qty: &Quantity) -> Self

Converts to this type from the input type.

impl From<&Quantity> for QuantityRaw

fn from(value: &Quantity) -> Self

Converts to this type from the input type.

impl From<&String> for Quantity

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Quantity

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Quantity> for f64

fn from(qty: Quantity) -> Self

Converts to this type from the input type.

impl From<Quantity> for QuantityRaw

fn from(value: Quantity) -> Self

Converts to this type from the input type.

impl From<String> for Quantity

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<i32> for Quantity

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Quantity

fn from(value: i64) -> 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 FromStr for Quantity

type Err = String

The associated error which can be returned from parsing.

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

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

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 IntoPy<Py<PyAny>> for Quantity

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for Quantity

type Target = Quantity

The Python output type

type Output = Bound<'py, <Quantity as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl Mul<f64> for Quantity

type Output = f64

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul for Quantity

type Output = Quantity

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T: Into<QuantityRaw>> MulAssign<T> for Quantity

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl Ord for Quantity

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

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

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

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

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

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

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

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

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

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

impl PyClass for Quantity

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Quantity

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Quantity>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Quantity> for PyClassImplCollector<Quantity>

fn new_text_signature(self) -> Option<&'static str>

impl PyClass__add__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __add__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__floordiv__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __floordiv__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__mod__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __mod__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__mul__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __mul__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__radd__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __radd__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rfloordiv__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __rfloordiv__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rmod__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __rmod__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rmul__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __rmul__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rsub__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __rsub__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rtruediv__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __rtruediv__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__sub__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __sub__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__truediv__SlotFragment<Quantity> for PyClassImplCollector<Quantity>

unsafe fn __truediv__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a Quantity

type Holder = Option<PyRef<'py, Quantity>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut Quantity

type Holder = Option<PyRefMut<'py, Quantity>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Quantity> for PyClassImplCollector<Quantity>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Quantity

const NAME: &'static str = "Quantity"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl Serialize for Quantity

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Quantity

type Output = Quantity

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<T: Into<QuantityRaw>> SubAssign<T> for Quantity

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl Copy for Quantity

impl DerefToPyAny for Quantity

impl Eq for Quantity