Enum PositionSide 

#[repr(C)]
pub enum PositionSide {
    NoPositionSide = 0,
    Flat = 1,
    Long = 2,
    Short = 3,
}

The market side for a specific position, or action related to positions.

Variants

NoPositionSide = 0

No position side is specified (only valid in the context of a filter for actions involving positions).

Flat = 1

A neural/flat position, where no position is currently held in the market.

Long = 2

A long position in the market, typically acquired through one or many BUY orders.

Short = 3

A short position in the market, typically acquired through one or many SELL orders.

Implementations

impl PositionSide

pub const fn from_repr(discriminant: usize) -> Option<PositionSide>

Try to create Self from the raw representation

impl PositionSide

pub fn as_specified(&self) -> PositionSideSpecified

Returns the specified PositionSideSpecified (Long, Short, or Flat) for this side.

Panics

Panics if self is PositionSide::NoPositionSide.

Trait Implementations

impl AsRef<str> for PositionSide

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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

Formats the value using the given formatter.

impl Default for PositionSide

fn default() -> PositionSide

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PositionSide

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

Formats the value using the given formatter.

impl Eq for PositionSide

impl FromStr for PositionSide

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PositionSide, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PositionSide

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 IntoEnumIterator for PositionSide

type Iterator = PositionSideIter

fn iter() -> PositionSideIter

impl Ord for PositionSide

fn cmp(&self, other: &PositionSide) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PositionSide

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

fn partial_cmp(&self, other: &PositionSide) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PositionSide

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 PositionSide

impl TryFrom<&str> for PositionSide

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<PositionSide, <Self as TryFrom<&str>>::Error>

Performs the conversion.