Enum RType

#[repr(u8)]
pub enum RType {
    Mbp0 = 0,
    Mbp1 = 1,
    Mbp10 = 10,
    OhlcvDeprecated = 17,
    Ohlcv1S = 32,
    Ohlcv1M = 33,
    Ohlcv1H = 34,
    Ohlcv1D = 35,
    OhlcvEod = 36,
    Status = 18,
    InstrumentDef = 19,
    Imbalance = 20,
    Error = 21,
    SymbolMapping = 22,
    System = 23,
    Statistics = 24,
    Mbo = 160,
    Cmbp1 = 177,
    Cbbo1S = 192,
    Cbbo1M = 193,
    Tcbbo = 194,
    Bbo1S = 195,
    Bbo1M = 196,
}

A record type, i.e. a sentinel for different types implementing HasRType.

Use in RecordHeader to indicate the type of record, which is useful when working with DBN streams containing multiple record types or an unknown record type.

Variants

Mbp0 = 0

Denotes a market-by-price record with a book depth of 0 (used for the Trades schema).

Mbp1 = 1

Denotes a market-by-price record with a book depth of 1 (also used for the Tbbo schema).

Mbp10 = 10

Denotes a market-by-price record with a book depth of 10.

OhlcvDeprecated = 17

👎Deprecated since 0.3.3: Separated into separate rtypes for each OHLCV schema.

Denotes an open, high, low, close, and volume record at an unspecified cadence.

Ohlcv1S = 32

Denotes an open, high, low, close, and volume record at a 1-second cadence.

Ohlcv1M = 33

Denotes an open, high, low, close, and volume record at a 1-minute cadence.

Ohlcv1H = 34

Denotes an open, high, low, close, and volume record at an hourly cadence.

Ohlcv1D = 35

Denotes an open, high, low, close, and volume record at a daily cadence based on the UTC date.

OhlcvEod = 36

Denotes an open, high, low, close, and volume record at a daily cadence based on the end of the trading session.

Status = 18

Denotes an exchange status record.

InstrumentDef = 19

Denotes an instrument definition record.

Imbalance = 20

Denotes an order imbalance record.

Error = 21

Denotes an error from gateway.

SymbolMapping = 22

Denotes a symbol mapping record.

System = 23

Denotes a non-error message from the gateway. Also used for heartbeats.

Statistics = 24

Denotes a statistics record from the publisher (not calculated by Databento).

Mbo = 160

Denotes a market by order record.

Cmbp1 = 177

Denotes a consolidated best bid and offer record.

Cbbo1S = 192

Denotes a consolidated best bid and offer record subsampled on a one-second interval.

Cbbo1M = 193

Denotes a consolidated best bid and offer record subsampled on a one-minute interval.

Tcbbo = 194

Denotes a consolidated best bid and offer trade record containing the consolidated BBO before the trade.

Bbo1S = 195

Denotes a best bid and offer record subsampled on a one-second interval.

Bbo1M = 196

Denotes a best bid and offer record subsampled on a one-minute interval.

Implementations

impl RType

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

Convert the RType type to its str representation.

Trait Implementations

impl Clone for RType

fn clone(&self) -> RType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RType

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

Formats the value using the given formatter.

impl From<Schema> for RType

Get the corresponding rtype for the given schema.

fn from(schema: Schema) -> Self

Converts to this type from the input type.

impl FromStr for RType

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 RType

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 RType

type Iterator = RTypeIter

fn iter() -> RTypeIter

impl IntoPy<Py<PyAny>> for RType

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

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for RType

type Target = RType

The Python output type

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

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

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

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RType

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

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<RType> for PyClassImplCollector<RType>

Available on crate feature python only.

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

impl PyClass__eq__SlotFragment<RType> for PyClassImplCollector<RType>

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, 'py> PyFunctionArgument<'a, 'py, false> for &'a RType

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

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

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

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

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

impl PyMethods<RType> for PyClassImplCollector<RType>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RType

const NAME: &'static str = "RType"

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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl TryFrom<u8> for RType

type Error = TryFromPrimitiveError<RType>

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 RType

const NAME: &'static str = "RType"

type Primitive = u8

type Error = TryFromPrimitiveError<RType>

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

impl Copy for RType

impl Eq for RType

impl StructuralPartialEq for RType