Struct SystemMsg 

#[repr(C)]
pub struct SystemMsg {
    pub hd: RecordHeader,
    pub msg: [c_char; 303],
    pub code: u8,
}

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

Fields

hd: RecordHeader

The common header.

msg: [c_char; 303]

The message from the Databento gateway.

code: u8

Type of system message. See the SystemCode enum for possible values.

Implementations

impl SystemMsg

pub fn new(ts_event: u64, code: Option<SystemCode>, 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.

pub fn code(&self) -> Result<SystemCode>

Parses the type of system message into an enum.

Errors

This function returns an error if the code field does not contain a valid SystemCode.

Trait Implementations

impl AsRef<[u8]> for SystemMsg

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

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

impl Clone for SystemMsg

fn clone(&self) -> SystemMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemMsg

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 SystemMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

Converts to this type from the input type.

impl From<&SystemMsgV1> for SystemMsg

fn from(old: &SystemMsg) -> Self

Converts to this type from the input type.

impl From<SystemMsg> for RecordEnum

fn from(rec: SystemMsg) -> Self

Converts to this type from the input type.

impl HasRType for SystemMsg

fn has_rtype(rtype: u8) -> bool

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

impl Hash for SystemMsg

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 SystemMsg

Available on crate feature python only.

Convert bare SystemMsg to Python by wrapping with UNDEF_TIMESTAMP for ts_out.

type Target = PyAny

The Python output type

type Output = Bound<'py, PyAny>

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::Output, Self::Error>

Performs the conversion.

impl PartialEq for SystemMsg

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

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

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 SystemMsg

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 SystemMsg

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 SystemMsg

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 SystemMsg

impl Eq for SystemMsg

impl StructuralPartialEq for SystemMsg