Skip to main content

ParticipantMessageData

Struct ParticipantMessageData 

Source
pub struct ParticipantMessageData {
    pub participant_guid: [u8; 16],
    pub kind: u32,
    pub data: Vec<u8>,
}
Expand description

ParticipantMessageData (DDSI-RTPS 2.5 §9.6.3.1) — payload of the DCPSParticipantMessage topic.

Fields§

§participant_guid: [u8; 16]

16-byte GUID of the sender (prefix + EntityId::PARTICIPANT). Even though the spec says “prefix”, Cyclone and Fast-DDS write the full GUID here; we follow.

§kind: u32

Liveliness kind (see PARTICIPANT_MESSAGE_DATA_KIND_*).

§data: Vec<u8>

Opaque token. On MANUAL_BY_TOPIC a topic hash, otherwise empty.

Implementations§

Source§

impl ParticipantMessageData

Source

pub fn automatic(prefix: GuidPrefix) -> Self

Constructor for an AUTOMATIC heartbeat (data empty).

Source

pub fn manual_by_participant(prefix: GuidPrefix) -> Self

Constructor for a MANUAL_BY_PARTICIPANT heartbeat (data empty).

Source

pub fn manual_by_topic(prefix: GuidPrefix, topic_token: Vec<u8>) -> Self

Constructor for ZeroDDS MANUAL_BY_TOPIC (data = topic token).

Source

pub fn to_cdr(&self, little_endian: bool) -> Result<Vec<u8>, WireError>

Encodes to CDR bytes (with a 4-byte encapsulation header). little_endian = trueENCAPSULATION_CDR_LE, otherwise BE.

§Errors

WireError::ValueOutOfRange if data.len() > MAX_DATA_LEN.

Source

pub fn from_cdr(bytes: &[u8]) -> Result<Self, WireError>

Decodes from CDR bytes (with an encapsulation header).

Accepts 0x0000/0x0001 (XCDR1 plain) and 0x0006/0x0007 (XCDR2 plain). Other encapsulation kinds → error.

Tolerant of the 12-byte prefix-only encoding (pads with 0 to 16 bytes).

§Errors
  • UnsupportedEncapsulation on non-CDR encapsulation
  • UnexpectedEof if the bytes are too short for header / body
  • ValueOutOfRange if data.len > MAX_DATA_LEN
Source

pub fn prefix(&self) -> GuidPrefix

Returns the GuidPrefix (first 12 bytes).

Source

pub fn is_vendor_kind(&self) -> bool

true if the kind value is vendor-specific (MSB set).

Trait Implementations§

Source§

impl Clone for ParticipantMessageData

Source§

fn clone(&self) -> ParticipantMessageData

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParticipantMessageData

Source§

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

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

impl Eq for ParticipantMessageData

Source§

impl PartialEq for ParticipantMessageData

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ParticipantMessageData

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.