pub struct ClosePositionInstructions {
    pub pos: Position,
    pub capped_exposure: Signed<Collateral>,
    pub additional_losses: Collateral,
    pub settlement_price: PricePoint,
    pub reason: PositionCloseReason,
    pub closed_during_liquifunding: bool,
}
Expand description

Instructions to close a position.

Closing a position can occur for multiple reasons: explicit action by the trader, settling price exposure (meaning: you hit a liquidation or take profit), insufficient margin… the point of this data structure is to capture all the information needed by the close position actions to do final settlement on a position and move it to the closed position data structures.

Fields§

§pos: Position

The position in its current state

§capped_exposure: Signed<Collateral>

The capped exposure amount after taking liquidation margin into account.

Positive value means a transfer from counter collateral to active collateral. Negative means active to counter collateral. This is not reflected in the position itself, since Position requires non-zero active and counter collateral, and it’s entirely possible we will consume the entirety of one of those fields.

§additional_losses: Collateral

Additional losses that the trader experienced that cut into liquidation margin.

If the trader experienced max gains, then this value is 0. In the case where the trader experienced a liquidation event and capped_exposure did not fully represent losses due to liquidation margin, this value contains additional losses we would like to take away from the trader after paying all pending fees.

§settlement_price: PricePoint

The price point used for settling this position.

§reason: PositionCloseReason§closed_during_liquifunding: bool

Did this occur because the position was closed during liquifunding?

Trait Implementations§

source§

impl Clone for ClosePositionInstructions

source§

fn clone(&self) -> ClosePositionInstructions

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ClosePositionInstructions

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<U> As for U

§

fn as_<T>(self) -> Twhere T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.