Enum TriggerType 

#[repr(C)]
pub enum TriggerType {
    Default = 1,
    LastPrice = 2,
    MarkPrice = 3,
    IndexPrice = 4,
    BidAsk = 5,
    DoubleLast = 6,
    DoubleBidAsk = 7,
    LastOrBidAsk = 8,
    MidPoint = 9,
}

The trigger type for the stop/trigger price of an order.

Python retains NO_TRIGGER as a compatibility alias for None. The alias is not an enum variant and may be removed in a future version.

Variants

Default = 1

The default trigger type set by the trading venue.

LastPrice = 2

Based on the last traded price for the instrument.

MarkPrice = 3

Based on the mark price for the instrument.

IndexPrice = 4

Based on the index price for the instrument.

BidAsk = 5

Based on the top-of-book quoted prices for the instrument.

DoubleLast = 6

Based on a ‘double match’ of the last traded price for the instrument

DoubleBidAsk = 7

Based on a ‘double match’ of the bid/ask price for the instrument

LastOrBidAsk = 8

Based on both the TriggerType::LastPrice and TriggerType::BidAsk.

MidPoint = 9

Based on the mid-point of the TriggerType::BidAsk.

Implementations

impl TriggerType

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

Try to create Self from the raw representation

impl TriggerType

pub fn name(&self) -> String

pub fn value(&self) -> u8

Trait Implementations

impl AsRef<str> for TriggerType

fn as_ref(&self) -> &str

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

impl Clone for TriggerType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TriggerType

impl Debug for TriggerType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TriggerType

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TriggerType

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

Formats the value using the given formatter.

impl Eq for TriggerType

impl<'a, 'py> FromPyObject<'a, 'py> for TriggerType

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl FromStr for TriggerType

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for TriggerType

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 TriggerType

type Iterator = TriggerTypeIter

fn iter() -> TriggerTypeIter

impl<'py> IntoPyObject<'py> for TriggerType

type Target = TriggerType

The Python output type

type Output = Bound<'py, TriggerType>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl Ord for TriggerType

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for TriggerType

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TriggerType

fn partial_cmp(&self, other: &Self) -> 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 PyClass for TriggerType

const NAME: &str = "TriggerType"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for TriggerType

const MODULE: Option<&str>

Module which the class will be associated with.

const RAW_DOC: &'static CStr = /// The trigger type for the stop/trigger price of an order. /// /// Python retains `NO_TRIGGER` as a compatibility alias for `None`. The alias is not an enum variant /// and may be removed in a future version.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<TriggerType as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<TriggerType>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForTriggerType

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for TriggerType

const TEXT_SIGNATURE: &'static str = "(value)"

impl PyStubType for TriggerType

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for TriggerType

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for TriggerType

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 TriggerType

impl TryFrom<&str> for TriggerType

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.