Struct HeartbeatRecord 

#[non_exhaustive]
pub struct HeartbeatRecord {
    pub timestamp: Option<Timestamp>,
    /* private fields */
}

A heartbeat record is returned as a progress indicator, when there are no data changes or any other partition record types in the change stream partition.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

timestamp: Option<Timestamp>

Indicates the timestamp at which the query has returned all the records in the change stream partition with timestamp <= heartbeat timestamp. The heartbeat timestamp will not be the same as the timestamps of other record types in the same partition.

Implementations

impl HeartbeatRecord

pub fn new() -> Self

Creates a new default instance.

pub fn set_timestamp<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of timestamp.

pub fn set_or_clear_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of timestamp.

Trait Implementations

impl Clone for HeartbeatRecord

fn clone(&self) -> HeartbeatRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeartbeatRecord

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

Formats the value using the given formatter.

impl Default for HeartbeatRecord

fn default() -> HeartbeatRecord

Returns the “default value” for a type.

impl Message for HeartbeatRecord

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HeartbeatRecord

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