Skip to main content

MicroReader

Struct MicroReader 

Source
pub struct MicroReader { /* private fields */ }
Expand description

MicroReader - DDS DataReader

Receives data samples from a topic.

§Design

  • BEST_EFFORT QoS (no acknowledgments)
  • No history cache (process immediately)
  • Fixed-size receive buffer

§Example

let reader = MicroReader::new(
    participant.guid_prefix(),
    reader_entity_id,
    "Temperature",
);

// Read sample
if let Some(sample) = reader.read(participant.transport_mut())? {
    let mut decoder = CdrDecoder::new(sample.payload);
    let temp: f32 = decoder.decode_f32()?;
    let timestamp: i64 = decoder.decode_i64()?;
}

Implementations§

Source§

impl MicroReader

Source

pub fn new( guid_prefix: GuidPrefix, entity_id: EntityId, topic_name: &str, ) -> Result<Self>

Create a new reader

§Arguments
  • guid_prefix - Participant’s GUID prefix
  • entity_id - Reader’s entity ID
  • topic_name - Topic name (max 63 chars)
Source

pub const fn guid(&self) -> GUID

Get reader GUID

Source

pub fn topic_name(&self) -> &str

Get topic name

Source

pub fn read<T: Transport>( &mut self, transport: &mut T, ) -> Result<Option<Sample<'_>>>

Read a sample (non-blocking)

Returns None if no sample available.

Trait Implementations§

Source§

impl Debug for MicroReader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for MicroReader

Source§

fn eq(&self, other: &MicroReader) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for MicroReader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.