Struct WithTsOut

#[repr(C)]
pub struct WithTsOut<T: HasRType> {
    pub rec: T,
    pub ts_out: u64,
}

Wrapper object for records that include the live gateway send timestamp (ts_out).

Fields

rec: T

The inner record.

ts_out: u64

The live gateway send timestamp expressed as the number of nanoseconds since the UNIX epoch.

See ts_out.

Implementations

impl<T: HasRType> WithTsOut<T>

pub fn new(rec: T, ts_out: u64) -> Self

Creates a new record with ts_out. Updates the length property in RecordHeader to ensure the additional field is accounted for.

pub fn ts_out(&self) -> OffsetDateTime

Parses the raw live gateway send timestamp into a datetime.

Trait Implementations

impl<T> AsRef<[u8]> for WithTsOut<T>

where T: HasRType,

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

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

impl<T: Clone + HasRType> Clone for WithTsOut<T>

fn clone(&self) -> WithTsOut<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + HasRType> Debug for WithTsOut<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for WithTsOut<T>

where T: Deserialize<'de> + HasRType,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: HasRType> HasRType for WithTsOut<T>

fn has_rtype(rtype: u8) -> bool

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

impl<T: Hash + HasRType> Hash for WithTsOut<T>

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, R> IntoPyObject<'py> for WithTsOut<R>

where R: HasRType + IntoPyObject<'py>,

Available on crate feature python only.

WithTsOut adds a ts_out field to the main record when converted to Python.

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<T: PartialEq + HasRType> PartialEq for WithTsOut<T>

fn eq(&self, other: &WithTsOut<T>) -> 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<T: HasRType> Record for WithTsOut<T>

fn header(&self) -> &RecordHeader

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

fn raw_index_ts(&self) -> u64

Returns the raw primary timestamp for the record.

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 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<T: HasRType> RecordMut for WithTsOut<T>

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

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

impl<T> Serialize for WithTsOut<T>

where T: Serialize + HasRType,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy + HasRType> Copy for WithTsOut<T>

impl<T: Eq + HasRType> Eq for WithTsOut<T>

impl<T: HasRType> StructuralPartialEq for WithTsOut<T>