Struct AccountBalance 

pub struct AccountBalance {
    pub currency: Currency,
    pub total: Money,
    pub locked: Money,
    pub free: Money,
}

Represents an account balance denominated in a particular currency.

Fields

currency: Currency

The account balance currency.

total: Money

The total account balance.

locked: Money

The account balance locked (assigned to pending orders).

free: Money

The account balance free for trading.

Implementations

impl AccountBalance

pub fn new_checked( total: Money, locked: Money, free: Money, ) -> CorrectnessResult<Self>

Creates a new AccountBalance instance with correctness checking.

Errors

Returns an error if total is not the result of locked + free.

Notes

PyO3 requires a Result type that stacktrace can be printed for errors.

pub fn new(total: Money, locked: Money, free: Money) -> Self

Creates a new AccountBalance instance.

Panics

Panics if a correctness check fails. See AccountBalance::new_checked for more details.

pub fn from_total_and_locked( total: Decimal, locked: Decimal, currency: Currency, ) -> CorrectnessResult<Self>

Creates a new AccountBalance from total and locked decimal amounts, deriving free in fixed-point so the total == locked + free invariant holds by construction at the currency precision.

When total is non-negative, locked is clamped into [0, total] so a transient rounding glitch or overshoot cannot leave free negative. When total is negative (spot borrow deficit or underwater margin account), locked is passed through verbatim so venue-reported reserved margin is preserved and free carries the shortfall.

Errors

Returns an error if total or locked cannot be represented at the currency precision.

pub fn from_total_and_free( total: Decimal, free: Decimal, currency: Currency, ) -> CorrectnessResult<Self>

Creates a new AccountBalance from total and free decimal amounts, deriving locked in fixed-point so the total == locked + free invariant holds by construction at the currency precision.

When total is non-negative, free is clamped into [0, total] so a transient PnL overshoot cannot leave locked negative. When total is negative, free is passed through verbatim so the venue-reported available amount is preserved and locked carries the difference.

Errors

Returns an error if total or free cannot be represented at the currency precision.

impl AccountBalance

pub fn py_from_dict(values: &Bound<'_, PyDict>) -> PyResult<Self>

Constructs an AccountBalance from a Python dict.

Errors

Returns a PyErr if parsing or conversion fails.

Panics

Panics if parsing numeric values (unwrap()) fails due to invalid format.

pub fn py_to_dict(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Converts this AccountBalance into a Python dict.

Errors

Returns a PyErr if serialization fails.

Trait Implementations

impl Clone for AccountBalance

fn clone(&self) -> AccountBalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountBalance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AccountBalance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AccountBalance

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for AccountBalance

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for AccountBalance

type Target = AccountBalance

The Python output type

type Output = Bound<'py, <AccountBalance 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 PartialEq for AccountBalance

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 PyClass for AccountBalance

const NAME: &str = "AccountBalance"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for AccountBalance

const MODULE: Option<&str>

Module which the class will be associated with.

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents an account balance denominated in a particular currency.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<AccountBalance as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<AccountBalance>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForAccountBalance

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

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for AccountBalance

const TEXT_SIGNATURE: &'static str = "(total, locked, free)"

impl PyStubType for AccountBalance

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for AccountBalance

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 is_type_of(object: &Bound<'_, PyAny>) -> bool

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

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

Checks if object is an instance of this type.

impl Serialize for AccountBalance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AccountBalance

impl DerefToPyAny for AccountBalance