Struct DataSample

pub struct DataSample<D: Keyed> { /* private fields */ }

A data sample and its associated metadata received from a WITH_KEY Topic.

Note that no_key::DataSample and with_key::DataSample are two different structs.

We are using Sample to replace the valid_data flag from the DDS spec, because when valid_data = false, the application should not be able to access any data.

Sample usage:

• Sample::Value(d) means valid_data == true and there is a sample d.
• Sample::Dispose(k) means valid_data == false, no sample exists, but only a Key k and instance_state has changed.

See also DDS spec v1.4 Section 2.2.2.5.4.

Implementations

impl<D> DataSample<D>

where D: Keyed,

pub fn key(&self) -> D::K

pub fn value(&self) -> &Sample<D, D::K>

pub fn into_value(self) -> Sample<D, D::K>

pub fn sample_info(&self) -> &SampleInfo

pub fn sample_info_mut(&mut self) -> &mut SampleInfo

Trait Implementations

impl<D: Debug + Keyed> Debug for DataSample<D>

where D::K: Debug,

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

Formats the value using the given formatter.

impl<D: PartialEq + Keyed> PartialEq for DataSample<D>

where D::K: PartialEq,

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