Enum PositionReport 

pub enum PositionReport {
    Unreported,
    Flat,
    Open(Position),
}

What a venue reported about its position in one instrument, in an InstrumentAccountSnapshot.

Only Flat and Open are claims about the position. A consumer comparing the venue’s position with its own (the engine does, see EngineOutput::PositionDrift in rustrade) must compare only those, and read nothing into Unreported or into an instrument the snapshot does not list.

Variants

Unreported

The venue does not report a position for this instrument: it does not report positions at all, it reports this holding as an asset balance instead (such as spot crypto), or this read could not establish it.

Flat

The venue reports positions for this instrument and holds none.

Open(Position)

The venue’s open position. A client must not report a zero quantity as open: build it with Self::from_position, which reports one as Flat.

Implementations

impl PositionReport

pub fn from_position(position: Position) -> Self

Report a position the venue returned: Flat when its quantity is zero, otherwise Open.

pub fn open(&self) -> Option<&Position>

The open position, if any.

pub fn quantity(&self) -> Option<Decimal>

The venue’s signed quantity: zero when Flat, None when Unreported.

pub fn is_unreported(&self) -> bool

Whether this is Unreported.

Trait Implementations

impl Clone for PositionReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositionReport

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

Formats the value using the given formatter.

impl Default for PositionReport

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PositionReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PositionReport

impl Hash for PositionReport

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 Ord for PositionReport

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PositionReport

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for PositionReport

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: &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 Serialize for PositionReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PositionReport