Struct rustdds::GUID

pub struct GUID {
    pub prefix: GuidPrefix,
    pub entity_id: EntityId,
}

DDS/RTPS GUID

Spec 2.5, Section 8.2.4.1 Identifying RTPS entities: the GUID

The GUID (Globally Unique Identifier) is an attribute of all RTPS Entities and uniquely identifies the Entity within a DDS Domain.

The GUID is built as a tuple <prefix, entityId> combining a GuidPrefix_t prefix and an EntityId_t entityId … The implementation is free to choose the prefix, as long as every Participant in the Domain has a unique GUID. … The GUIDs of all the Endpoints within a Participant have the same prefix.

Fields

prefix: GuidPrefix

entity_id: EntityId

Implementations

impl GUID

pub const GUID_UNKNOWN: Self

pub fn new(prefix: GuidPrefix, entity_id: EntityId) -> Self

basic constructor from components

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

pub fn new_participant_guid() -> Self

Generates new GUID for Participant when guid_prefix is random

pub fn dummy_test_guid(entity_kind: EntityKind) -> Self

pub fn from_prefix(self, entity_id: EntityId) -> Self

Generates GUID for specific entity_id from current prefix

pub fn new_with_prefix_and_id(prefix: GuidPrefix, entity_id: EntityId) -> Self

alias for basic constructor from components

pub fn as_usize(&self) -> usize

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

Trait Implementations

impl CdrEncodingSize for GUID

fn cdr_encoding_max_size() -> CdrEncodingMaxSize

impl Clone for GUID

fn clone(&self) -> GUID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GUID

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

Formats the value using the given formatter.

impl Default for GUID

fn default() -> GUID

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GUID

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for GUID

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, 

Feeds a slice of this type into the given Hasher.

impl Key for GUID

fn hash_key(&self) -> KeyHash

impl Ord for GUID

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<GUID> for GUID

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<GUID> for GUID

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a_, C_: Context> Readable<'a_, C_> for GUID

fn read_from<R_: Reader<'a_, C_>>(_reader_: &mut R_) -> Result<Self, C_::Error>

fn minimum_bytes_needed() -> usize

fn read_from_buffer(buffer: &'a [u8]) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer.

fn read_with_length_from_buffer(
    buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize) where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer while also returning the amount of bytes consumed.

fn read_from_buffer_copying_data(
    buffer: &[u8]
) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer.

fn read_with_length_from_buffer_copying_data(
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize) where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer while also returning the amount of bytes consumed.

fn read_from_stream_unbuffered(
    stream: impl Read
) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Reads from a given stream without any buffering.

fn read_from_stream_buffered(
    stream: impl Read
) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Reads from a given stream with internal buffering.

fn read_from_file(path: impl AsRef<Path>) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn read_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut(
    context: &mut C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_stream_buffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_file_with_ctx(
    context: C,
    path: impl AsRef<Path>
) -> Result<Self, <C as Context>::Error>

impl Serialize for GUID

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<C_: Context> Writable<C_> for GUID

fn write_to<T_: ?Sized + Writer<C_>>(
    &self,
    _writer_: &mut T_
) -> Result<(), C_::Error>

fn write_to_buffer(
    &self,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_vec(&self) -> Result<Vec<u8, Global>, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_stream<S>(&self, stream: S) -> Result<(), <C as Context>::Error> where
    S: Write,
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_file(
    &self,
    path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_buffer_with_ctx(
    &self,
    context: C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut(
    &self,
    context: &mut C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx(
    &self,
    context: C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut(
    &self,
    context: &mut C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>(
    &self,
    context: C,
    stream: S
) -> Result<(), <C as Context>::Error> where
    S: Write, 

fn write_to_file_with_ctx(
    &self,
    context: C,
    path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Copy for GUID

impl Eq for GUID

impl StructuralEq for GUID

impl StructuralPartialEq for GUID