Struct Locator 

pub struct Locator {
    pub kind: LocatorKind,
    pub port: u32,
    pub address: [u8; 16],
}

Locator: 24-byte address (kind + port + 16-byte address).

Fields

kind: LocatorKind

Address family.

port: u32

UDP port.

address: [u8; 16]

16-byte address. UDPv4 uses the last 4 bytes, 0 before that.

Implementations

impl Locator

pub const WIRE_SIZE: usize = 24

Wire size: 24 bytes.

pub const INVALID: Self

Spec §8.3.5.7 LOCATOR_INVALID.

pub const RESERVED: Self

Spec §8.3.5.7 LOCATOR_KIND_RESERVED template (kind=0, port=0, address=0).

pub const UDP_V4_ANY: Self

Spec §8.3.5.7 — default UDPv4 locator (kind=1, port=0, addr=0).

pub const UDP_V6_ANY: Self

Spec §8.3.5.7 — default UDPv6 locator (kind=2, port=0, addr=0).

pub const SHM_ANY: Self

ZeroDDS vendor-extension SHM locator template.

pub const PORT_INVALID: u32 = 0

Spec §8.3.5.7 — LOCATOR_PORT_INVALID sentinel.

pub const ADDRESS_INVALID: [u8; 16]

Spec §8.3.5.7 — LOCATOR_ADDRESS_INVALID sentinel.

pub fn udp_v6(addr: [u8; 16], port: u32) -> Self

Constructor for UDPv6 (16-byte address + port).

pub fn udp_v4(addr: [u8; 4], port: u32) -> Self

Constructor for UDPv4 (a.b.c.d:port).

pub fn tcp_v4(addr: [u8; 4], port: u32) -> Self

Constructor for TCPv4 (DDS-TCP-PSM §4).

pub fn tcp_v6(addr: [u8; 16], port: u32) -> Self

Constructor for TCPv6 (DDSI-RTPS 2.5 §9.4, LocatorKind=8). 16-byte network-byte-order address.

pub fn new_tcp_v4(addr: [u8; 4], port: u32) -> Self

👎Deprecated:

use Locator::tcp_v4 instead (naming consistency)

Legacy alias for Self::tcp_v4. Deprecated: rename call sites to tcp_v4 (consistent with udp_v4).

pub fn uds(id: [u8; 16]) -> Self

Constructor for a Unix domain socket endpoint with a 16-byte ID. The port stays 0 (not meaningful for UDS). The transport resolves the ID to /<base_dir>/<hex>.sock.

pub fn shm(id: [u8; 16]) -> Self

Constructor for a shared-memory segment with an ID (16-byte token). The port field stays 0 (not meaningful for SHM).

pub fn tsn(mac: [u8; 6], vlan_vid: u16) -> Self

Constructor for a TSN L2 endpoint (DDS-TSN 1.0 Annex A). mac is the 6-byte destination MAC, vlan_vid the IEEE 802.1Q VID (0 = untagged). Layout in the 16-byte address field: bytes 0..6 MAC, bytes 6..8 VID (big-endian), rest 0. The port stays 0.

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

Extracts the IPv4 address (only meaningful for kind == UdpV4).

pub fn to_bytes_le(self) -> [u8; 24]

LE encoder.

pub fn to_bytes_be(self) -> [u8; 24]

BE encoder (for PL_CDR_BE, e.g. handshake c.pdata).

pub fn from_bytes_le(bytes: [u8; 24]) -> Result<Self, WireError>

LE decoder.

Errors

WireError::InvalidLocatorKind on an unknown kind.

Trait Implementations

impl Clone for Locator

fn clone(&self) -> Locator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Locator

impl Debug for Locator

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

Formats the value using the given formatter.

impl Eq for Locator

impl Hash for Locator

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 Locator

fn cmp(&self, other: &Locator) -> 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 Locator

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Locator

fn partial_cmp(&self, other: &Locator) -> 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 Locator