Enum PositionSide 

pub enum PositionSide {
    Long,
    Short,
}

The direction of a position.

Variants

Long

Long: profits when the price rises.

Short

Short: profits when the price falls.

Implementations

impl PositionSide

pub fn sign(self) -> Decimal

+1 for long, -1 for short.

pub fn for_order(side: OrderSide, reduce_only: bool) -> PositionSide

Which side of a hedged account an order acts on.

In PositionMode::Hedge a symbol carries a long and a short position at once, so an order has to name the one it means. OrderRequest does not carry that name, and does not need to: buying opens the long side or closes the short one, and selling does the reverse. reduce_only is what separates the two.

side	reduce_only	acts on
buy	false	long, opening
sell	false	short, opening
buy	true	short, closing
sell	true	long, closing

Every venue that supports hedged accounts spells this the same way under a different field name, so the mapping lives here once.

Trait Implementations

impl Clone for PositionSide

fn clone(&self) -> PositionSide

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PositionSide

impl Debug for PositionSide

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PositionSide

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PositionSide

impl PartialEq for PositionSide

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PositionSide

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PositionSide