Enum SType 

#[repr(u8)]
pub enum SType {
    InstrumentId = 0,
    RawSymbol = 1,
    Smart = 2,
    Continuous = 3,
    Parent = 4,
    NasdaqSymbol = 5,
    CmsSymbol = 6,
    Isin = 7,
    UsCode = 8,
    BbgCompId = 9,
    BbgCompTicker = 10,
    Figi = 11,
    FigiTicker = 12,
}

A symbology type. Refer to the symbology documentation for more information.

Variants

InstrumentId = 0

Symbology using a unique numeric ID.

RawSymbol = 1

Symbology using the original symbols provided by the publisher.

Smart = 2

👎Deprecated since 0.5.0: Smart was split into continuous and parent.

A set of Databento-specific symbologies for referring to groups of symbols.

Continuous = 3

A Databento-specific symbology where one symbol may point to different instruments at different points of time, e.g. to always refer to the front month future.

Parent = 4

A Databento-specific symbology for referring to a group of symbols by one “parent” symbol, e.g. ES.FUT to refer to all ES futures.

NasdaqSymbol = 5

Symbology for US equities using NASDAQ Integrated suffix conventions.

CmsSymbol = 6

Symbology for US equities using CMS suffix conventions.

Isin = 7

Symbology using International Security Identification Numbers (ISIN) - ISO 6166.

UsCode = 8

Symbology using US domestic Committee on Uniform Securities Identification Procedure (CUSIP) codes.

BbgCompId = 9

Symbology using Bloomberg composite global IDs.

BbgCompTicker = 10

Symbology using Bloomberg composite tickers.

Figi = 11

Symbology using Bloomberg FIGI exchange level IDs.

FigiTicker = 12

Symbology using Bloomberg exchange level tickers.

Implementations

impl SType

pub const fn as_str(&self) -> &'static str

Converts the SType to its str representation.

Trait Implementations

impl AsRef<str> for SType

fn as_ref(&self) -> &str

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

impl Clone for SType

fn clone(&self) -> SType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SType

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for SType

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

Formats the value using the given formatter.

impl From<SType> for u8

fn from(enum_value: SType) -> Self

Converts to this type from the input type.

impl FromStr for SType

type Err = Error

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 SType

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 SType

type Iterator = STypeIter

fn iter() -> STypeIter

impl<'py> IntoPyObject<'py> for SType

type Target = SType

The Python output type

type Output = Bound<'py, <SType 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 SType

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

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

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for SType

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 = /// A symbology type. Refer to the /// [symbology documentation](https://databento.com/docs/api-reference-historical/basics/symbology) /// for more information.

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<SType>

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for SType

Available on crate feature python only.

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

impl PyClass__eq__SlotFragment<SType> for PyClassImplCollector<SType>

Available on crate feature python only.

unsafe fn __eq__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder SType

type Holder = Option<PyClassGuard<'a, SType>>

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

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut SType

type Holder = Option<PyClassGuardMut<'a, SType>>

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

impl PyMethods<SType> for PyClassImplCollector<SType>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for SType

const NAME: &'static str = "SType"

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(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 SType

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u8> for SType

type Error = TryFromPrimitiveError<SType>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for SType

const NAME: &'static str = "SType"

type Primitive = u8

type Error = TryFromPrimitiveError<SType>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for SType

impl Eq for SType

impl StructuralPartialEq for SType