Struct PositionStatusReport 

pub struct PositionStatusReport {
    pub account_id: AccountId,
    pub instrument_id: InstrumentId,
    pub position_side: PositionSideSpecified,
    pub quantity: Quantity,
    pub signed_decimal_qty: Decimal,
    pub report_id: UUID4,
    pub ts_last: UnixNanos,
    pub ts_init: UnixNanos,
    pub venue_position_id: Option<PositionId>,
    pub avg_px_open: Option<Decimal>,
}

Represents a position status at a point in time.

Fields

account_id: AccountId

The account ID associated with the position.

instrument_id: InstrumentId

The instrument ID associated with the event.

position_side: PositionSideSpecified

The position side.

quantity: Quantity

The current open quantity.

signed_decimal_qty: Decimal

The current signed quantity as a decimal (positive for position side LONG, negative for SHORT).

report_id: UUID4

The unique identifier for the event.

ts_last: UnixNanos

UNIX timestamp (nanoseconds) when the last event occurred.

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the event was initialized.

venue_position_id: Option<PositionId>

The position ID (assigned by the venue).

avg_px_open: Option<Decimal>

The reported average open price for the position.

Implementations

impl PositionStatusReport

pub fn new( account_id: AccountId, instrument_id: InstrumentId, position_side: PositionSideSpecified, quantity: Quantity, ts_last: UnixNanos, ts_init: UnixNanos, report_id: Option<UUID4>, venue_position_id: Option<PositionId>, avg_px_open: Option<Decimal>, ) -> Self

Creates a new PositionStatusReport instance with required fields.

pub const fn has_venue_position_id(&self) -> bool

Checks if the position has a venue position ID.

pub fn is_flat(&self) -> bool

Checks if this is a flat position (quantity is zero).

pub fn is_long(&self) -> bool

Checks if this is a long position.

pub fn is_short(&self) -> bool

Checks if this is a short position.

impl PositionStatusReport

pub fn py_from_dict(py: Python<'_>, values: Py<PyDict>) -> PyResult<Self>

Creates a PositionStatusReport from a Python dictionary.

Errors

Returns a Python exception if conversion from dict fails.

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

Converts the PositionStatusReport to a Python dictionary.

Errors

Returns a Python exception if conversion to dict fails.

Trait Implementations

impl CatalogPathPrefix for PositionStatusReport

fn path_prefix() -> &'static str

Returns the path prefix (directory name) for this data type.

impl Clone for PositionStatusReport

fn clone(&self) -> PositionStatusReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositionStatusReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PositionStatusReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PositionStatusReport

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

Formats the value using the given formatter.

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

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 HasTsInit for PositionStatusReport

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

impl<'py> IntoPyObject<'py> for PositionStatusReport

type Target = PositionStatusReport

The Python output type

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

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

const NAME: &str = "PositionStatusReport"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PositionStatusReport

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 position status at a point in time.

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

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

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 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 PositionStatusReport

const TEXT_SIGNATURE: &'static str = "(account_id, instrument_id, position_side, quantity, ts_last, ts_init, report_id=None, venue_position_id=None, avg_px_open=None)"

impl PyStubType for PositionStatusReport

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 PositionStatusReport

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 PositionStatusReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for PositionStatusReport

impl Eq for PositionStatusReport

impl StructuralPartialEq for PositionStatusReport