Struct rustdds::dds::with_key::DataSample

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

DDS spec 2.2.2.5.4

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

We are making a bit unorthodox use of Result: It replaces the use of valid_data flag, because when valid_data = false, we should not provide any data value. Now

• Ok(D) means valid_data = true and there is a sample.
• Err(D::K) means valid_data = false, no sample exists, but only a Key and instance_state has changed.

Implementations

impl<D> DataSample<D> where
    D: Keyed, 

pub fn get_key(&self) -> D::K where
    <D as Keyed>::K: Key, 

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

pub fn into_value(self) -> Result<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<DataSample<D>> for DataSample<D> where
    D::K: PartialEq, 

fn eq(&self, other: &DataSample<D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DataSample<D>) -> bool

This method tests for !=.

impl<D: Keyed> StructuralPartialEq for DataSample<D>