Struct PositionChangedEvent

pub struct PositionChangedEvent {
    pub final_position: Option<Position>,
    pub position_notional: String,
    pub transaction_fee: Option<Coin>,
    pub realized_pnl: String,
    pub bad_debt: Option<Coin>,
    pub funding_payment: String,
    pub block_height: i64,
    pub margin_to_user: String,
    pub change_reason: String,
    pub exchanged_size: String,
    pub exchanged_notional: String,
}

Emitted when a position changes.

Fields

final_position: Option<Position>

position_notional: String

Position notional (in quote units) after the change. In general, ‘notional = baseAmount * priceQuotePerBase’, where size is the baseAmount.

transaction_fee: Option<Coin>

Transaction fee paid. A “taker” fee.

realized_pnl: String

realize profits and losses after the change

bad_debt: Option<Coin>

Amount of bad debt cleared by the PerpEF during the change. Bad debt is negative net margin past the liquidation point of a position.

funding_payment: String

A funding payment made or received by the trader on the current position. ‘fundingPayment’ is positive if ‘owner’ is the sender and negative if ‘owner’ is the receiver of the payment. Its magnitude is abs(size * fundingRate). Funding payments act to converge the mark price and index price (average price on major exchanges).

block_height: i64

The block number at which this position was changed.

margin_to_user: String

margin_to_user is the amount of collateral received by the trader during the position change. A positve value indicates that the trader received funds, while a negative value indicates that the trader spent funds.

change_reason: String

change_reason describes the reason for why the position resulted in a change. Change type can take the following values:

• CHANGE_REASON_UNSPECIFIED: Unspecified change reason.
• CHANGE_REASON_ADD_MARGIN: Margin was added to the position.
• CHANGE_REASON_REMOVE_MARGIN: Margin was removed from the position.
• CHANGE_REASON_OPEN_POSITION: A new position was opened.
• CHANGE_REASON_CLOSE_POSITION: An existing position was closed.

exchanged_size: String

exchanged_size represent the change in size for an existing position after the change. A positive value indicates that the position size increased, while a negative value indicates that the position size decreased.

exchanged_notional: String

exchanged_notional represent the change in notional for an existing position after the change. A positive value indicates that the position notional increased, while a negative value indicates that the position notional decreased.

Trait Implementations

impl Clone for PositionChangedEvent

fn clone(&self) -> PositionChangedEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositionChangedEvent

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

Formats the value using the given formatter.

impl Default for PositionChangedEvent

fn default() -> Self

Returns the “default value” for a type.

impl Message for PositionChangedEvent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PositionChangedEvent

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