Struct InstrumentId 

#[repr(C)]
pub struct InstrumentId {
    pub symbol: Symbol,
    pub venue: Venue,
}

Represents a valid instrument ID.

The symbol and venue combination should uniquely identify the instrument.

Fields

symbol: Symbol

The instruments ticker symbol.

venue: Venue

The instruments trading venue.

Implementations

impl InstrumentId

pub fn new(symbol: Symbol, venue: Venue) -> Self

Creates a new InstrumentId instance.

pub fn is_synthetic(&self) -> bool

impl InstrumentId

pub fn from_as_ref<T: AsRef<str>>(value: T) -> Result<Self, InstrumentIdError>

Errors

Returns an error if value is not a valid identifier.

pub fn blockchain(&self) -> Option<Blockchain>

Extracts the blockchain from the venue if it’s a DEX venue.

pub fn parse_parent_components(&self) -> Option<(&str, InstrumentClass)>

Returns the parent-symbol components (root, class) if this id has a recognised parent shape <root>.<class> in its symbol component.

Returns None when the symbol has zero or more than one ., or when the suffix is not a recognised InstrumentClass parent suffix (see InstrumentClass::try_from_parent_suffix).

Used to gate parent-style subscription fan-out: a None return means the id does not refer to a parent group and must not be expanded.

Trait Implementations

impl Clone for InstrumentId

fn clone(&self) -> InstrumentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InstrumentId

impl Debug for InstrumentId

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

Formats the value using the given formatter.

impl DerefToPyAny for InstrumentId

impl<'de> Deserialize<'de> for InstrumentId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstrumentId

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

Formats the value using the given formatter.

impl Eq for InstrumentId

impl<T: AsRef<str>> From<T> for InstrumentId

fn from(value: T) -> Self

Converts to this type from the input type.

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

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 InstrumentId

type Err = InstrumentIdError

The associated error which can be returned from parsing.

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

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

impl Hash for InstrumentId

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<'py> IntoPyObject<'py> for InstrumentId

type Target = InstrumentId

The Python output type

type Output = Bound<'py, <InstrumentId as IntoPyObject<'py>>::Target>

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>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl Ord for InstrumentId

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

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

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

const NAME: &str = "InstrumentId"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for InstrumentId

const MODULE: Option<&str>

Module which the class will be associated with.

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)]

const RAW_DOC: &'static CStr = /// Represents a valid instrument ID. /// /// The symbol and venue combination should uniquely identify the instrument.

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 = <<InstrumentId as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<InstrumentId>

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 = Pyo3MethodsInventoryForInstrumentId

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

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 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 InstrumentId

const TEXT_SIGNATURE: &'static str = "(symbol, venue)"

impl PyStubType for InstrumentId

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 InstrumentId

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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 InstrumentId

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 InstrumentId

impl TestDefault for InstrumentId

fn test_default() -> Self

Creates a new test default InstrumentId instance.