Skip to main content

PositionManager

Struct PositionManager 

Source
pub struct PositionManager<AssetKey = AssetIndex, InstrumentKey = InstrumentIndex> {
    pub mode: OmsMode,
    pub positions: IndexMap<PositionId, Position<AssetKey, InstrumentKey>>,
}
Expand description

Manages open positions for a single instrument.

Supports two OMS modes (configurable at construction):

  • Netting (default): at most one entry; same flip/close logic as before.
  • Hedging: multiple concurrent entries, keyed by PositionId.

Fields§

§mode: OmsMode§positions: IndexMap<PositionId, Position<AssetKey, InstrumentKey>>

All currently open positions keyed by PositionId.

Implementations§

Source§

impl<AssetKey, InstrumentKey> PositionManager<AssetKey, InstrumentKey>

Source

pub fn new(mode: OmsMode) -> Self

Construct a new PositionManager with the given OMS mode and no open positions.

Source§

impl<AssetKey: Debug + Clone, InstrumentKey> PositionManager<AssetKey, InstrumentKey>

Source

pub fn update_from_trade( &mut self, trade: &Trade<AssetKey, InstrumentKey>, contract_size: Decimal, ) -> Option<PositionExited<AssetKey, InstrumentKey>>
where InstrumentKey: Debug + Clone + PartialEq,

Updates the current position state based on a new trade.

This method handles:

  • Opening a new position if none exists
  • Updating an existing position (increase/decrease/close)
  • Handling position flips (close existing & open new with any remaining trade quantity)

In Netting mode the PositionId is derived deterministically as "netting". In Hedging mode the PositionId is derived from trade.order_id.

§Warning — Hedging mode callers

In OmsMode::Hedging, this method derives the PositionId directly from trade.order_id. The engine’s actual fill routing instead resolves the PositionId via a ClientOrderId → PositionId lookup table populated at order submission time (see InstrumentState::update_from_trade). Calling this method directly in Hedging mode bypasses that lookup and will open a spurious position slot under the exchange order ID rather than the caller’s chosen PositionId. Prefer routing fills through InstrumentState::update_from_trade, or call update_from_trade_with_id with the already-resolved PositionId.

§Arguments
  • trade - The trade to process
  • contract_size - Contract multiplier for derivatives (1 for spot, 100 for standard options)
Source

pub fn update_from_trade_with_id( &mut self, trade: &Trade<AssetKey, InstrumentKey>, position_id: &PositionId, contract_size: Decimal, ) -> Option<PositionExited<AssetKey, InstrumentKey>>
where InstrumentKey: Debug + Clone + PartialEq,

Updates position state routing to a specific PositionId.

Suitable for callers (e.g. expiry settlement) that have already resolved the correct PositionId and want to bypass the automatic derivation.

§Arguments
  • trade - The trade to process
  • position_id - The resolved position ID to route the fill to
  • contract_size - Contract multiplier for derivatives (1 for spot, 100 for standard options)
§Fee model

This method does not apply a fee model — trade.fees.fees is used as-is. The caller is responsible for ensuring the fee value is correct before calling. For contract expiry settlement the caller must set fees to Decimal::ZERO (exchange settlement commission, if any, is not modelled and must be tracked separately).

Trait Implementations§

Source§

impl<AssetKey: Clone, InstrumentKey: Clone> Clone for PositionManager<AssetKey, InstrumentKey>

Source§

fn clone(&self) -> PositionManager<AssetKey, InstrumentKey>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<AssetKey: Debug, InstrumentKey: Debug> Debug for PositionManager<AssetKey, InstrumentKey>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<AssetKey, InstrumentKey> Default for PositionManager<AssetKey, InstrumentKey>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, AssetKey, InstrumentKey> Deserialize<'de> for PositionManager<AssetKey, InstrumentKey>
where AssetKey: Deserialize<'de>, InstrumentKey: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<AssetKey: PartialEq, InstrumentKey: PartialEq> PartialEq for PositionManager<AssetKey, InstrumentKey>

Source§

fn eq(&self, other: &PositionManager<AssetKey, InstrumentKey>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<AssetKey, InstrumentKey> Serialize for PositionManager<AssetKey, InstrumentKey>
where AssetKey: Serialize, InstrumentKey: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<AssetKey: PartialEq, InstrumentKey: PartialEq> StructuralPartialEq for PositionManager<AssetKey, InstrumentKey>

Auto Trait Implementations§

§

impl<AssetKey, InstrumentKey> Freeze for PositionManager<AssetKey, InstrumentKey>

§

impl<AssetKey, InstrumentKey> RefUnwindSafe for PositionManager<AssetKey, InstrumentKey>
where InstrumentKey: RefUnwindSafe, AssetKey: RefUnwindSafe,

§

impl<AssetKey, InstrumentKey> Send for PositionManager<AssetKey, InstrumentKey>
where InstrumentKey: Send, AssetKey: Send,

§

impl<AssetKey, InstrumentKey> Sync for PositionManager<AssetKey, InstrumentKey>
where InstrumentKey: Sync, AssetKey: Sync,

§

impl<AssetKey, InstrumentKey> Unpin for PositionManager<AssetKey, InstrumentKey>
where InstrumentKey: Unpin, AssetKey: Unpin,

§

impl<AssetKey, InstrumentKey> UnsafeUnpin for PositionManager<AssetKey, InstrumentKey>

§

impl<AssetKey, InstrumentKey> UnwindSafe for PositionManager<AssetKey, InstrumentKey>
where InstrumentKey: UnwindSafe, AssetKey: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more