Struct Settlement 

pub struct Settlement {

    pub settlement_type: SettlementType,
    pub timestamp: i64,
    pub instrument_name: Option<String>,
    pub position_size: Option<f64>,
    pub mark_price: Option<f64>,
    pub index_price: Option<f64>,
    pub profit_loss: Option<f64>,
    pub funding: Option<f64>,
    pub session_profit_loss: Option<f64>,
    pub session_bankrupt_cy: Option<f64>,
    pub session_tax: Option<f64>,
    pub session_tax_rate: Option<f64>,
    pub socialized_losses: Option<f64>,
    pub additional_fields: HashMap<String, Value>,
}

Settlement event information

Fields

settlement_type: SettlementType

Type of settlement event

timestamp: i64

Timestamp of the settlement event (milliseconds since Unix epoch)

instrument_name: Option<String>

Instrument name (settlement and delivery only)

position_size: Option<f64>

Position size in quote currency (settlement and delivery only)

mark_price: Option<f64>

Mark price at settlement time in quote currency (settlement and delivery only)

index_price: Option<f64>

Underlying index price at time of event in quote currency (settlement and delivery only)

profit_loss: Option<f64>

Profit and loss in base currency (settlement and delivery only)

funding: Option<f64>

Funding in base currency (settlement for perpetual product only)

session_profit_loss: Option<f64>

Session profit and loss (optional)

session_bankrupt_cy: Option<f64>

Session bankruptcy (optional)

session_tax: Option<f64>

Session tax (optional)

session_tax_rate: Option<f64>

Session tax rate (optional)

socialized_losses: Option<f64>

Socialized losses (optional)

additional_fields: HashMap<String, Value>

Additional fields that might be present in the API response

Implementations

impl Settlement

pub fn new(settlement_type: SettlementType, timestamp: i64) -> Self

Create a new settlement event

pub fn for_instrument( settlement_type: SettlementType, timestamp: i64, instrument_name: String, ) -> Self

Create a settlement event for an instrument

pub fn with_position(self, size: f64, mark_price: f64, index_price: f64) -> Self

Set position details

pub fn with_pnl(self, pnl: f64) -> Self

Set profit/loss

pub fn with_funding(self, funding: f64) -> Self

Set funding (for perpetuals)

pub fn is_settlement(&self) -> bool

Check if this is a settlement event

pub fn is_delivery(&self) -> bool

Check if this is a delivery event

pub fn is_bankruptcy(&self) -> bool

Check if this is a bankruptcy event

Trait Implementations

impl Clone for Settlement

fn clone(&self) -> Settlement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settlement

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

Formats the value using the given formatter.

impl Default for Settlement

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settlement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Settlement

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

Formats the value using the given formatter.

impl PartialEq for Settlement

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

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 Settlement