Struct EntityId 

pub struct EntityId {
    pub entity_key: [u8; 3],
    pub entity_kind: EntityKind,
}

EntityId: 4-byte endpoint identifier within a participant. Layout: 3 bytes entity_key + 1 byte entity_kind.

Fields

entity_key: [u8; 3]

First 3 bytes (key).

entity_kind: EntityKind

Last byte (kind).

Implementations

impl EntityId

pub const WIRE_SIZE: usize = 4

Wire size: 4 bytes.

pub const UNKNOWN: Self

Sentinel.

pub const PARTICIPANT: Self

Reserved participant EntityId (Spec §9.3.1.2).

pub const SPDP_BUILTIN_PARTICIPANT_WRITER: Self

SPDP Builtin Participant Writer (Spec §9.3.1.5 Table 9.4). Multicast beacon sender in the discovery path.

pub const SPDP_BUILTIN_PARTICIPANT_READER: Self

SPDP Builtin Participant Reader.

pub const SEDP_BUILTIN_SUBSCRIPTIONS_WRITER: Self

SEDP Subscriptions Writer .

pub const SEDP_BUILTIN_SUBSCRIPTIONS_READER: Self

SEDP Subscriptions Reader .

pub const SEDP_BUILTIN_PUBLICATIONS_WRITER: Self

SEDP Publications Writer .

pub const SEDP_BUILTIN_PUBLICATIONS_READER: Self

SEDP Publications Reader .

pub const BUILTIN_PARTICIPANT_MESSAGE_WRITER: Self

BUILTIN_PARTICIPANT_MESSAGE_WRITER — Writer Liveliness Protocol (WLP). Sends ParticipantMessageData over the topic DCPSParticipantMessage (DDSI-RTPS 2.5 §8.4.13, §9.3.1.5 Tab. 9.4 — EntityKey [00, 02, 00], EntityKind BuiltinWriterWithKey = 0xC2).

pub const BUILTIN_PARTICIPANT_MESSAGE_READER: Self

BUILTIN_PARTICIPANT_MESSAGE_READER — counterpart to the WLP writer (DDSI-RTPS 2.5 §8.4.13, §9.3.1.5 Tab. 9.4).

pub const TL_SVC_REQ_WRITER: Self

TypeLookup Service Request Writer.

pub const TL_SVC_REQ_READER: Self

TypeLookup Service Request Reader.

pub const TL_SVC_REPLY_WRITER: Self

TypeLookup Service Reply Writer.

pub const TL_SVC_REPLY_READER: Self

TypeLookup Service Reply Reader.

pub const SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER: Self

SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER — secure SEDP publications writer (bit 16, §9.3.1.6 Tab.13).

pub const SEDP_BUILTIN_PUBLICATIONS_SECURE_READER: Self

SEDP_BUILTIN_PUBLICATIONS_SECURE_READER — Bit 17.

pub const SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER: Self

SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER — Bit 18.

pub const SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER: Self

SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER — Bit 19.

pub const BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER: Self

BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER — secure WLP writer (bit 20, §7.4.7.1).

pub const BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER: Self

BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER — Bit 21.

pub const BUILTIN_PARTICIPANT_STATELESS_MESSAGE_WRITER: Self

BUILTIN_PARTICIPANT_STATELESS_MESSAGE_WRITER — auth-handshake topic writer (bit 22, §7.4.7.1, §10.3.4 auth stateless wire). NoKey, since the stateless topic is keyless.

pub const BUILTIN_PARTICIPANT_STATELESS_MESSAGE_READER: Self

BUILTIN_PARTICIPANT_STATELESS_MESSAGE_READER — Bit 23.

pub const BUILTIN_PARTICIPANT_VOLATILE_MESSAGE_SECURE_WRITER: Self

BUILTIN_PARTICIPANT_VOLATILE_MESSAGE_SECURE_WRITER — crypto key-exchange topic writer (bit 24, §7.4.7.1, §10.5.4 VolatileMessageSecure wire).

pub const BUILTIN_PARTICIPANT_VOLATILE_MESSAGE_SECURE_READER: Self

BUILTIN_PARTICIPANT_VOLATILE_MESSAGE_SECURE_READER — Bit 25.

pub const SPDP_RELIABLE_BUILTIN_PARTICIPANTS_SECURE_WRITER: Self

SPDP_RELIABLE_BUILTIN_PARTICIPANTS_SECURE_WRITER — secure SPDP writer for the DCPSParticipantsSecure topic (bit 26).

pub const SPDP_RELIABLE_BUILTIN_PARTICIPANTS_SECURE_READER: Self

SPDP_RELIABLE_BUILTIN_PARTICIPANTS_SECURE_READER — Bit 27.

pub const fn user_writer_with_key(key: [u8; 3]) -> Self

Constructs a user-writer endpoint with key.

pub const fn user_reader_with_key(key: [u8; 3]) -> Self

Constructs a user-reader endpoint with key.

pub const fn user_writer_no_key(key: [u8; 3]) -> Self

Constructs a user-writer endpoint without key (NoKey). Spec §9.3.1.2 Table 9.1: entity_kind=0x03 for NoKey writers. Important for cross-vendor interop: if the IDL type has no @key, the writer must be published as NoKey, otherwise a remote reader rejects the DATA submessage (writer/reader kind mismatch).

pub const fn user_reader_no_key(key: [u8; 3]) -> Self

Constructs a user-reader endpoint without key (NoKey). Spec §9.3.1.2 Table 9.1: entity_kind=0x04 for NoKey readers.

pub const fn is_secure_builtin(self) -> bool

True if this is one of the 12 secure builtin EntityIds from DDS-Security 1.2 §7.4.7.1 Tab.7.

pub fn to_bytes(self) -> [u8; 4]

Bytes [key0, key1, key2, kind].

pub fn from_bytes(bytes: [u8; 4]) -> Self

Reads 4 bytes.

Trait Implementations

impl Clone for EntityId

fn clone(&self) -> EntityId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EntityId

impl Debug for EntityId

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

Formats the value using the given formatter.

impl Eq for EntityId

impl Hash for EntityId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EntityId

fn cmp(&self, other: &EntityId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EntityId

fn eq(&self, other: &EntityId) -> 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 PartialOrd for EntityId

fn partial_cmp(&self, other: &EntityId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for EntityId