Struct InstanceHandle 

pub struct InstanceHandle(/* private fields */);

Opaque InstanceHandle_t (DDS-DCPS 1.4 §2.3.3).

Implementations

impl InstanceHandle

pub const NIL: InstanceHandle

Reserved “no handle” value (spec convention).

pub const fn from_raw(raw: u64) -> InstanceHandle

Constructor from a raw u64 value. Low-level API — normally the InstanceHandleAllocator produces the values.

pub const fn as_raw(&self) -> u64

Raw value.

pub const fn is_nil(&self) -> bool

true if the handle is Self::NIL.

pub fn from_guid(guid: Guid) -> InstanceHandle

Deterministic derivation of an InstanceHandle from a Guid (16-byte BuiltinTopicKey). Used for the ignore_* / get_discovered_* APIs (DDS DCPS 1.4 §2.2.2.2.1.14-17, §2.2.2.2.1.27-30), because there the spec requires InstanceHandle_t as the argument, while the builtin subscriber keeps BuiltinTopicKey_t (= Guid) as the sample key.

Implementation: 64-bit FNV-1a over all 16 bytes — fast, no_std, low collision for a few thousand discovered entities. HANDLE_NIL is avoided by bumping it up to 1.

Trait Implementations

impl Clone for InstanceHandle

fn clone(&self) -> InstanceHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InstanceHandle

impl Debug for InstanceHandle

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

Formats the value using the given formatter.

impl Default for InstanceHandle

fn default() -> InstanceHandle

Returns the “default value” for a type.

impl Display for InstanceHandle

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

Formats the value using the given formatter.

impl Eq for InstanceHandle

impl Hash for InstanceHandle

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

where __H: Hasher,

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 InstanceHandle

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

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

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