Enum Side 

pub enum Side {
    Buy,
    Sell,
}

Represents the side of a trade or order.

This enum is Copy and intended to behave like a small value type. It does not encode numeric meaning implicitly — use methods like Side::sign if a signed representation is needed.

Variants

Buy

Buy side (long direction).

Sell

Sell side (short direction).

Implementations

impl Side

pub fn is_buy(self) -> bool

Returns true if the side is Side::Buy.

pub fn is_sell(self) -> bool

Returns true if the side is Side::Sell.

pub fn opposite(self) -> Self

Returns the opposite trading side.

Examples

use openpit::param::Side;

assert_eq!(Side::Buy.opposite(), Side::Sell);
assert_eq!(Side::Sell.opposite(), Side::Buy);

pub fn sign(self) -> i8

Returns a signed representation of the side.

+1 for Side::Buy, -1 for Side::Sell.

Intended for financial calculations (e.g., signed quantity or exposure).

Trait Implementations

impl Clone for Side

fn clone(&self) -> Side

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Side

impl Debug for Side

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

Formats the value using the given formatter.

impl Display for Side

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

Formats the value using the given formatter.

impl Eq for Side

impl Hash for Side

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Side

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