Struct MarginBalance 

pub struct MarginBalance {
    pub initial: Money,
    pub maintenance: Money,
    pub currency: Currency,
    pub instrument_id: Option<InstrumentId>,
}

Represents a margin balance.

Margin entries have two mutually exclusive scopes:

• Per-instrument: instrument_id = Some(id). Used for isolated margin and for calculated margin in backtest mode where each instrument carries its own reserve.
• Account-wide (cross margin): instrument_id = None. Used for venues that report a single aggregate margin per collateral currency (most derivatives venues in cross-margin mode).

Fields

initial: Money

maintenance: Money

currency: Currency

instrument_id: Option<InstrumentId>

Implementations

impl MarginBalance

pub fn new_checked( initial: Money, maintenance: Money, instrument_id: Option<InstrumentId>, ) -> CorrectnessResult<Self>

Creates a new MarginBalance instance with correctness checking.

Errors

Returns an error if initial and maintenance have different currencies.

Notes

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

pub fn new( initial: Money, maintenance: Money, instrument_id: Option<InstrumentId>, ) -> Self

Creates a new MarginBalance instance.

Panics

Panics if initial and maintenance have different currencies.

impl MarginBalance

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

Constructs a MarginBalance from a Python dict.

Errors

Returns a PyErr if parsing or conversion fails.

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

Converts this MarginBalance into a Python dict.

Errors

Returns a PyErr if serialization fails.

Trait Implementations

impl Clone for MarginBalance

fn clone(&self) -> MarginBalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MarginBalance

impl Debug for MarginBalance

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

Formats the value using the given formatter.

impl DerefToPyAny for MarginBalance

impl<'de> Deserialize<'de> for MarginBalance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MarginBalance

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

Formats the value using the given formatter.

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

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 MarginBalance

type Target = MarginBalance

The Python output type

type Output = Bound<'py, <MarginBalance 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 MarginBalance

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 MarginBalance

const NAME: &str = "MarginBalance"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for MarginBalance

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 a margin balance. /// /// Margin entries have two mutually exclusive scopes: /// /// - Per-instrument: `instrument_id = Some(id)`. Used for isolated margin and /// for calculated margin in backtest mode where each instrument carries its /// own reserve. /// - Account-wide (cross margin): `instrument_id = None`. Used for venues that /// report a single aggregate margin per collateral currency (most derivatives /// venues in cross-margin mode).

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 = <<MarginBalance as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<MarginBalance>

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 = Pyo3MethodsInventoryForMarginBalance

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 MarginBalance

const TEXT_SIGNATURE: &'static str = "(initial, maintenance, instrument_id=None)"

impl PyStubType for MarginBalance

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 MarginBalance

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 MarginBalance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.