Skip to main content

KeyHolderNesting

Enum KeyHolderNesting 

Source
pub enum KeyHolderNesting {
    Recursive,
    KeylessNestedWhole,
}
Expand description

How far Step 1’s member removal reaches into a key holder.

XTypes 1.3 §7.6.8 Step 1 keeps the key members of the holder —

If there are any key members, then remove the non-key members from FooKeyHolder. Otherwise do not remove any members.

— and Step 3 says to “apply steps 1 and 2 recursively to the members of FooKeyHolder if they are themselves AggregatedTypes”. FooKeyHolder at that point is whatever Step 1 left, so for a keyless aggregate it is every member, and Step 3 applies to all of them. The recursion has no depth limit written into it.

§What the vendors do

Measured on 2026-08-09 through keyhash-probe/ — Cyclone DDS 11.0.1, RTI Connext 7.7.0, Fast DDS from source. Three shapes:

@final struct NestedNoKey        { long a; long b; };
@final struct OuterKeylessNested { @key NestedNoKey inner; long tail; };

@final struct DeepLeaf  { @key long p; long q; };
@final struct DeepMid   { DeepLeaf leaf; long r; };   // no key of its own
@final struct DeepOuter { @key DeepMid mid; long tail; };

@final struct ChainLeaf  { @key long p; long q; };
@final struct ChainMid   { @key ChainLeaf inner; long r; };
@final struct ChainOuter { @key ChainMid mid; long tail; };

All three vendors, under every encoding, give OuterKeylessNested both of NestedNoKey’s members and ChainOuter only p — so the “otherwise do not remove any members” clause holds, and the recursion through keyed levels is unlimited everywhere.

They part over DeepOuter, where a keyless level sits above a keyed one:

DeepOuter holder
Cyclone, XCDR1 and XCDR20d0d0d0d 0f0f0f0f — p and r
Fast DDSthe same
RTI, XCDR2the same
RTI, XCDR10d0d0d0d 0e0e0e0e 0f0f0f0f — p, q and r

RTI’s XCDR1 holder stops filtering at the first keyless aggregate and takes what is under it whole: maxSizeSerializedKey V1 / V2 reports 12 / 8 for that type, so the two holders are genuinely different types and not one type serialized twice.

Variants§

§

Recursive

Step 1 applies at every level, however deep. The clause, and what four of the five measured combinations do.

§

KeylessNestedWhole

The first keyless aggregate is taken whole; nothing below it is filtered.

RTI Connext 7.7 under XCDR1. Under XCDR2 RTI recurses like everyone else, which is why Dialect::key_holder_nesting takes the encoding.

Implementations§

Source§

impl KeyHolderNesting

Source

pub const ALL: [Self; 2]

Both.

Source

pub const fn is_default(self) -> bool

Whether this is the default.

Source

pub const fn as_str(self) -> &'static str

Short name, for configuration and diagnostics.

Source

pub fn parse(value: &str) -> Option<Self>

Parse a configuration value.

An unknown value returns None rather than falling back to the default: a typo here changes every instance handle.

Trait Implementations§

Source§

impl Clone for KeyHolderNesting

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for KeyHolderNesting

Source§

impl Debug for KeyHolderNesting

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KeyHolderNesting

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for KeyHolderNesting

Source§

impl Hash for KeyHolderNesting

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for KeyHolderNesting

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for KeyHolderNesting

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for KeyHolderNesting

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for KeyHolderNesting

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.