Struct rustdds::dds::sampleinfo::SampleInfo

pub struct SampleInfo { /* private fields */ }

SampleInfo is metadata attached to each received data sample. It exists only at the receiving end of DDS, and is (mostly) generated by DDS.

Some of the SampleInfo field description texts are quoted from the DDS Specification.

Implementations

impl SampleInfo

pub fn source_timestamp(&self) -> Option<Timestamp>

Source timestamp is the timestamp that was supplied by the DataWriter that sent this sample. It is optional to timestamp samples when writing.

pub fn sample_state(&self) -> SampleState

pub fn view_state(&self) -> ViewState

pub fn instance_state(&self) -> InstanceState

pub fn disposed_generation_count(&self) -> i32

pub fn no_writers_generation_count(&self) -> i32

pub fn sample_rank(&self) -> i32

pub fn generation_rank(&self) -> i32

pub fn absolute_generation_rank(&self) -> i32

pub fn publication_handle(&self) -> GUID

publication_handle identifies the DataWriter that modified the instance (i.e. wrote this sample)

pub fn writer_guid(&self) -> GUID

pub fn related_sample_identity(&self) -> Option<SampleIdentity>

pub fn sample_identity(&self) -> SampleIdentity

Trait Implementations

impl Clone for SampleInfo

fn clone(&self) -> SampleInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampleInfo

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

Formats the value using the given formatter.

impl PartialEq for SampleInfo

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

impl StructuralPartialEq for SampleInfo