Struct DataHolder 

pub struct DataHolder {
    pub class_id: String,
    pub properties: Vec<WireProperty>,
    pub binary_properties: Vec<BinaryProperty>,
}

Spec §7.2.7 Tab.7 — generic DataHolder_t wire struct. All security tokens are type aliases of DataHolder with a fixed class_id value.

Fields

class_id: String

Plugin class id, e.g. "DDS:Auth:PKI-DH:1.2".

properties: Vec<WireProperty>

String properties (spec §7.2.6 Tab.5).

binary_properties: Vec<BinaryProperty>

Binary properties (spec §7.2.6 Tab.6).

Implementations

impl DataHolder

pub fn new(class_id: impl Into<String>) -> Self

Constructor with only class_id.

pub fn with_property( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Builder: adds a string property.

pub fn with_binary_property( self, name: impl Into<String>, value: impl Into<Vec<u8>>, ) -> Self

Builder: adds a binary property.

pub fn set_property( &mut self, name: impl Into<String>, value: impl Into<String>, )

Mut variant: sets a string property with replace-on-dup semantics (if the name already exists, the old value is overwritten — spec §7.2.6: per token each property name may appear only once).

pub fn set_binary_property( &mut self, name: impl Into<String>, value: impl Into<Vec<u8>>, )

Mut variant: sets a binary property with replace-on-dup.

pub fn property(&self, name: &str) -> Option<&str>

Looks up a string property by name.

pub fn binary_property(&self, name: &str) -> Option<&[u8]>

Looks up a binary property by name.

pub fn to_cdr_le(&self) -> Vec<u8>

XCDR1 little-endian encoder. Returns the bytes without the encapsulation header — that is supplied by the caller (e.g. the ParameterList value).

pub fn to_cdr_be(&self) -> Vec<u8>

XCDR1-Big-Endian-Encoder.

pub fn from_cdr_le(bytes: &[u8]) -> SecurityResult<Self>

XCDR1-Decoder, Little-Endian.

Errors

BadArgument if the bytes are not spec-conformant (e.g. premature end, overly long length prefixes).

pub fn from_cdr_le_consumed(bytes: &[u8]) -> SecurityResult<(Self, usize)>

Like from_cdr_le, additionally returns the number of bytes consumed. For inline sequence<DataHolder> decoding (spec GenericMessageData), where multiple DataHolders lie one after another without a length prefix.

Errors

BadArgument on non-spec-conformant bytes.

pub fn from_cdr_be(bytes: &[u8]) -> SecurityResult<Self>

XCDR1-Decoder, Big-Endian.

Errors

BadArgument if the bytes are not spec-conformant.

impl DataHolder

pub fn pki_dh_v12( cert_sn: impl Into<String>, cert_algo: impl Into<String>, ca_sn: impl Into<String>, ca_algo: impl Into<String>, ) -> Self

Builtin helper for the PKI-DH IdentityToken (§10.3.2.1 Tab.51). Properties dds.cert.sn, dds.cert.algo, dds.ca.sn, dds.ca.algo. No binary_properties.

pub fn permissions_v12( perm_ca_sn: impl Into<String>, perm_ca_algo: impl Into<String>, ) -> Self

Builtin helper for the permissions token (§10.4.2 Tab.65). class_id="DDS:Access:Permissions:1.2", properties dds.perm_ca.sn + dds.perm_ca.algo.

Trait Implementations

impl Clone for DataHolder

fn clone(&self) -> DataHolder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataHolder

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

Formats the value using the given formatter.

impl Default for DataHolder

fn default() -> DataHolder

Returns the “default value” for a type.

impl Eq for DataHolder

impl PartialEq for DataHolder

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