Struct Symbol

#[repr(C)]
pub struct Symbol(/* private fields */);

Represents a valid ticker symbol ID for a tradable instrument.

Implementations

impl Symbol

pub fn new_checked<T: AsRef<str>>(value: T) -> Result<Self>

Creates a new Symbol instance with correctness checking.

Error

Returns an error if value is not a valid string.

Notes

PyO3 requires a Result type for proper error handling and stacktrace printing in Python.

pub fn new<T: AsRef<str>>(value: T) -> Self

Creates a new Symbol instance.

Panic

• If value is not a valid string.

pub fn from_str_unchecked<T: AsRef<str>>(s: T) -> Self

pub const fn from_ustr_unchecked(s: Ustr) -> Self

pub fn inner(&self) -> Ustr

Returns the inner identifier value.

pub fn as_str(&self) -> &str

Returns the inner identifier value as a string slice.

pub fn is_composite(&self) -> bool

Returns true if the symbol string contains a period (.).

pub fn root(&self) -> &str

Returns the symbol root.

The symbol root is the substring that appears before the first period (.) in the full symbol string. It typically represents the underlying asset for futures and options contracts. If no period is found, the entire symbol string is considered the root.

pub fn topic(&self) -> String

Returns the symbol topic.

The symbol topic is the root symbol with a wildcard (*) appended if the symbol has a root, otherwise returns the full symbol string.

Trait Implementations

impl AsRef<str> for Symbol

fn as_ref(&self) -> &str

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

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Default for Symbol

fn default() -> Self

Creates a new default Symbol instance for testing.

impl<'de> Deserialize<'de> for Symbol

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Symbol

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

Formats the value using the given formatter.

impl From<&str> for Symbol

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Symbol

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Ustr> for Symbol

fn from(value: Ustr) -> Self

Converts to this type from the input type.

impl Hash for Symbol

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 IntoPy<Py<PyAny>> for Symbol

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl Ord for Symbol

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

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

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Symbol

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

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Symbol>

This handles following two situations:

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Symbol> for PyClassImplCollector<Symbol>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Symbol

type Holder = Option<PyRef<'py, Symbol>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Symbol

type Holder = Option<PyRefMut<'py, Symbol>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Symbol> for PyClassImplCollector<Symbol>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Symbol

const NAME: &'static str = "Symbol"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl Serialize for Symbol

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToPyObject for Symbol

fn to_object(&self, py: Python<'_>) -> PyObject

Converts self into a Python object.

impl Copy for Symbol

impl DerefToPyAny for Symbol

impl Eq for Symbol

impl StructuralPartialEq for Symbol