Struct SystemMsgV1 

#[repr(C)]
pub struct SystemMsgV1 {
    pub hd: RecordHeader,
    pub msg: [c_char; 64],
}

A non-error message from the Databento Live Subscription Gateway (LSG) in DBN version 1. Also used for heartbeating.

Fields

hd: RecordHeader

The common header.

msg: [c_char; 64]

The message from the Databento gateway.

Implementations

impl SystemMsg

pub fn new(ts_event: u64, msg: &str) -> Result<Self>

Creates a new SystemMsg.

Errors

This function returns an error if msg is too long.

pub fn heartbeat(ts_event: u64) -> Self

Creates a new heartbeat SystemMsg.

pub fn is_heartbeat(&self) -> bool

Checks whether the message is a heartbeat from the gateway.

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

Parses the message from the Databento gateway into a &str.

Errors

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

Trait Implementations

impl AsRef<[u8]> for SystemMsgV1

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

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

impl Clone for SystemMsgV1

fn clone(&self) -> SystemMsgV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemMsgV1

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

Formats the value using the given formatter.

impl Default for SystemMsg

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SystemMsgV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SystemMsgV1> for SystemMsg

fn from(old: &SystemMsg) -> Self

Converts to this type from the input type.

impl HasRType for SystemMsgV1

fn has_rtype(rtype: u8) -> bool

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

impl Hash for SystemMsgV1

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 SystemMsgV1

type Target = SystemMsgV1

The Python output type

type Output = Bound<'py, <SystemMsgV1 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 PartialEq for SystemMsgV1

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

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

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 SystemMsgV1

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for SystemMsgV1

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 non-error message from the Databento Live Subscription Gateway (LSG) in DBN version 1. /// Also used for heartbeating.

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

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

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

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for SystemMsg

Available on crate feature python only.

const TEXT_SIGNATURE: &'static str = "(ts_event, msg)"

impl PyMethods<SystemMsgV1> for PyClassImplCollector<SystemMsg>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for SystemMsgV1

const NAME: &'static str = "SystemMsgV1"

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 Record for SystemMsgV1

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 SystemMsgV1

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

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

impl Serialize for SystemMsgV1

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl WritePyRepr for SystemMsgV1

Available on crate feature python only.

fn write_py_repr(&self, s: &mut String) -> Result

Writes a Python-style string representation to s.

const SHOULD_FLATTEN: bool = false

Whether this type’s fields should be flattened into the parent repr.

impl Copy for SystemMsgV1

impl DerefToPyAny for SystemMsgV1

impl Eq for SystemMsgV1

impl ExtractPyClassWithClone for SystemMsgV1

impl StructuralPartialEq for SystemMsgV1