Struct rustdds::dds::no_key::DataReader

pub struct DataReader<D: DeserializeOwned, DA: DeserializerAdapter<D> = CDRDeserializerAdapter<D>> { /* private fields */ }

DDS DataReader for no key topics.

Examples

use serde::{Serialize, Deserialize};
use rustdds::dds::DomainParticipant;
use rustdds::dds::qos::QosPolicyBuilder;
use rustdds::dds::data_types::TopicKind;
use rustdds::no_key::DataReader;
use rustdds::serialization::CDRDeserializerAdapter;

let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let subscriber = domain_participant.create_subscriber(&qos).unwrap();

#[derive(Serialize, Deserialize)]
struct SomeType {}

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None);

Implementations

impl<D, DA> DataReader<D, DA>where D: DeserializeOwned + 'static, DA: DeserializerAdapter<D>,

pub fn read( &mut self, max_samples: usize, read_condition: ReadCondition ) -> Result<Vec<DataSample<&D>>>

Reads amount of samples found with max_samples and read_condition parameters.

Arguments

• max_samples - Limits maximum amount of samples read
• read_condition - Limits results by condition

Examples

use rustdds::dds::data_types::ReadCondition;

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
let data = data_reader.read(10, ReadCondition::not_read());

pub fn take( &mut self, max_samples: usize, read_condition: ReadCondition ) -> Result<Vec<DataSample<D>>>

Takes amount of sample found with max_samples and read_condition parameters.

Arguments

• max_samples - Limits maximum amount of samples read
• read_condition - Limits results by condition

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
let data = data_reader.take(10, ReadCondition::not_read());

pub fn read_next_sample(&mut self) -> Result<Option<DataSample<&D>>>

Reads next unread sample

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
while let Ok(Some(data)) = data_reader.read_next_sample() {
  // Do something
}

pub fn take_next_sample(&mut self) -> Result<Option<DataSample<D>>>

Takes next unread sample

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
while let Ok(Some(data)) = data_reader.take_next_sample() {
  // Do something
}

pub fn iterator(&mut self) -> Result<impl Iterator<Item = &D>>

Produces an interator over the currently available NOT_READ samples. Yields only payload data, not SampleInfo metadata This is not called iter() because it takes a mutable reference to self.

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
for data in data_reader.iterator() {
  // Do something
}

pub fn conditional_iterator( &mut self, read_condition: ReadCondition ) -> Result<impl Iterator<Item = &D>>

Produces an interator over the samples filtered b ygiven condition. Yields only payload data, not SampleInfo metadata

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
for data in data_reader.conditional_iterator(ReadCondition::any()) {
  // Do something
}

pub fn into_iterator(&mut self) -> Result<impl Iterator<Item = D>>

Produces an interator over the currently available NOT_READ samples. Yields only payload data, not SampleInfo metadata Removes samples from DataReader. Note! If the iterator is only partially consumed, all the samples it could have provided are still removed from the Datareader.

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
for data in data_reader.into_iterator() {
  // Do something
}

pub fn into_conditional_iterator( &mut self, read_condition: ReadCondition ) -> Result<impl Iterator<Item = D>>

Produces an interator over the samples filtered b ygiven condition. Yields only payload data, not SampleInfo metadata Note! If the iterator is only partially consumed, all the samples it could have provided are still removed from the Datareader.

Examples

let mut data_reader = subscriber.create_datareader_no_key::<SomeType, CDRDeserializerAdapter<_>>(&topic, None).unwrap();
for data in data_reader.into_conditional_iterator(ReadCondition::any()) {
  // Do something
}

pub fn async_sample_stream(self) -> DataReaderStream<D, DA>

An async stream for reading the (bare) data samples

Trait Implementations

impl<D, DA> Evented for DataReader<D, DA>where D: DeserializeOwned, DA: DeserializerAdapter<D>,

WARNING! UNTESTED

fn register( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt ) -> Result<()>

Register self with the given Poll instance.

fn reregister( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt ) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance

impl<D, DA> HasQoSPolicy for DataReader<D, DA>where D: DeserializeOwned + 'static, DA: DeserializerAdapter<D>,

fn qos(&self) -> QosPolicies

impl<D, DA> RTPSEntity for DataReader<D, DA>where D: DeserializeOwned + 'static, DA: DeserializerAdapter<D>,

fn guid(&self) -> GUID

fn entity_id(&self) -> EntityId

fn guid_prefix(&self) -> GuidPrefix

impl<D, DA> Source for DataReader<D, DA>where D: DeserializeOwned, DA: DeserializerAdapter<D>,

WARNING! UNTESTED

fn register( &mut self, registry: &Registry, token: Token, interests: Interest ) -> Result<()>

Register self with the given Registry instance.

fn reregister( &mut self, registry: &Registry, token: Token, interests: Interest ) -> Result<()>

Re-register self with the given Registry instance.

fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister self from the given Registry instance.

impl<D, DA> StatusEvented<DataReaderStatus> for DataReader<D, DA>where D: DeserializeOwned, DA: DeserializerAdapter<D>,

WARNING! UNTESTED

fn as_status_evented(&mut self) -> &dyn Evented

fn as_status_source(&mut self) -> &mut dyn Source

fn try_recv_status(&self) -> Option<DataReaderStatus>