Struct dbn::record::SymbolMappingMsg

#[repr(C)]
pub struct SymbolMappingMsg {
    pub hd: RecordHeader,
    pub stype_in: u8,
    pub stype_in_symbol: [c_char; 71],
    pub stype_out: u8,
    pub stype_out_symbol: [c_char; 71],
    pub start_ts: u64,
    pub end_ts: u64,
}

A symbol mapping message which maps a symbol of one SType to another.

Fields

hd: RecordHeader

The common header.

stype_in: u8

The input symbology type of stype_in_symbol.

stype_in_symbol: [c_char; 71]

The input symbol.

stype_out: u8

The output symbology type of stype_out_symbol.

stype_out_symbol: [c_char; 71]

The output symbol.

start_ts: u64

The start of the mapping interval expressed as the number of nanoseconds since the UNIX epoch.

end_ts: u64

The end of the mapping interval expressed as the number of nanoseconds since the UNIX epoch.

Implementations

impl SymbolMappingMsg

pub fn new( instrument_id: u32, ts_event: u64, stype_in: SType, stype_in_symbol: &str, stype_out: SType, stype_out_symbol: &str, start_ts: u64, end_ts: u64 ) -> Result<Self>

Creates a new SymbolMappingMsgV2.

Errors

This function returns an error if stype_in_symbol or stype_out_symbol contain more than maximum number of characters of 70.

pub fn stype_in(&self) -> Result<SType>

Returns the input symbology type.

Errors

This function returns an error if stype_in does not contain a valid SType.

pub fn stype_in_symbol(&self) -> Result<&str>

Returns the input symbol as a &str.

Errors

This function returns an error if stype_in_symbol contains invalid UTF-8.

pub fn stype_out(&self) -> Result<SType>

Returns the output symbology type.

Errors

This function returns an error if stype_out does not contain a valid SType.

pub fn stype_out_symbol(&self) -> Result<&str>

Returns the output symbol as a &str.

Errors

This function returns an error if stype_out_symbol contains invalid UTF-8.

pub fn start_ts(&self) -> Option<OffsetDateTime>

Parses the raw start of the mapping interval into a datetime. Returns None if start_ts contains the sentinel for a null timestamp.

pub fn end_ts(&self) -> Option<OffsetDateTime>

Parses the raw end of the mapping interval into a datetime. Returns None if end_ts contains the sentinel for a null timestamp.

Trait Implementations

impl AsRef<[u8]> for SymbolMappingMsg

fn as_ref(&self) -> &[u8]

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

impl Clone for SymbolMappingMsg

fn clone(&self) -> SymbolMappingMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolMappingMsg

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

Formats the value using the given formatter.

impl Default for SymbolMappingMsg

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a SymbolMappingMsg> for RecordRefEnum<'a>

fn from(rec: &'a SymbolMappingMsg) -> Self

Converts to this type from the input type.

impl From<&SymbolMappingMsgV1> for SymbolMappingMsg

fn from(old: &SymbolMappingMsgV1) -> Self

Converts to this type from the input type.

impl From<SymbolMappingMsg> for RecordEnum

fn from(rec: SymbolMappingMsg) -> Self

Converts to this type from the input type.

impl HasRType for SymbolMappingMsg

fn has_rtype(rtype: u8) -> bool

Returns true if rtype matches the value associated with the implementing type.

impl IntoPy<Py<PyAny>> for SymbolMappingMsg

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

Performs the conversion.

impl PartialEq for SymbolMappingMsg

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SymbolMappingMsg

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for SymbolMappingMsg

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for SymbolMappingMsg

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

This handles following two situations:

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

Immutable or mutable

type Dict = PyClassDictSlot

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 dict_offset() -> Option<Py_ssize_t>

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

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<SymbolMappingMsg> for PyClassImplCollector<SymbolMappingMsg>

Available on crate feature python only.

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

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

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

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

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

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

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

impl PyMethods<SymbolMappingMsg> for PyClassImplCollector<SymbolMappingMsg>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for SymbolMappingMsg

type AsRefTarget = PyCell<SymbolMappingMsg>

Utility type to make Py::as_ref work.

const NAME: &'static str = "SymbolMappingMsg"

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<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

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

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Record for SymbolMappingMsg

fn header(&self) -> &RecordHeader

Returns a reference to the RecordHeader that comes at the beginning of all record types.

fn record_size(&self) -> usize

Returns the size of the record in bytes.

fn rtype(&self) -> Result<RType>

Tries to convert the raw record type into an enum which is useful for exhaustive pattern matching.

fn publisher(&self) -> Result<Publisher>

Tries to convert the raw publisher_id into an enum which is useful for exhaustive pattern matching.

fn raw_index_ts(&self) -> u64

Returns the raw primary timestamp for the record.

fn index_ts(&self) -> Option<OffsetDateTime>

Returns the primary timestamp for the record. Returns None if the primary timestamp contains the sentinel value for a null timestamp.

fn index_date(&self) -> Option<Date>

Returns the primary date for the record; the date component of the primary timestamp (index_ts()). Returns None if the primary timestamp contains the sentinel value for a null timestamp.

impl RecordMut for SymbolMappingMsg

fn header_mut(&mut self) -> &mut RecordHeader

Returns a mutable reference to the RecordHeader that comes at the beginning of all record types.

impl SymbolMappingRec for SymbolMappingMsgV2

fn stype_in_symbol(&self) -> Result<&str>

Returns the input symbol as a &str.

fn stype_out_symbol(&self) -> Result<&str>

Returns the output symbol as a &str.

fn start_ts(&self) -> Option<OffsetDateTime>

Parses the raw start of the mapping interval into a datetime. Returns None if start_ts contains the sentinel for a null timestamp.

fn end_ts(&self) -> Option<OffsetDateTime>

Parses the raw end of the mapping interval into a datetime. Returns None if end_ts contains the sentinel for a null timestamp.

impl Copy for SymbolMappingMsg

impl Eq for SymbolMappingMsg

impl StructuralEq for SymbolMappingMsg

impl StructuralPartialEq for SymbolMappingMsg