Skip to main content

CollectionDelimiterPolicy

Enum CollectionDelimiterPolicy 

Source
pub enum CollectionDelimiterPolicy {
    Specification,
    EnumIsPrimitive,
    Never,
}
Expand description

Which collections carry a DHEADER under XCDR2.

XTypes 1.3 §7.4.3.5 rules (8) through (13): a collection of a primitive element type serialises identically under both versions, and every other collection is delimited under XCDR2. §7.2.2.2 lists the primitive types; an enumeration is a constructed type under §7.2.2.4.1 and is therefore not one.

§The three implementations disagree

Measured on 2026-08-09, XCDR2 little-endian, payload bytes:

element typeCycloneRTI 7.7Fast DDS
@final struct Cell, Cell items[2]201620
@final struct Cell, sequence<Cell>242024
@appendable struct, sequence<>322832
enum Colour, Colour cs[2]1288
enum Colour, sequence<Colour>161212

The runs are in tests/fixtures/vendor_bytes.md. Only Cyclone matches the specification on every row.

Changing this changes the bytes on the wire. Unlike the length-code policy, a conforming reader cannot absorb the difference: there is no flag in the stream saying whether the four bytes it is looking at are a delimiter or the first element.

Variants§

§

Specification

Delimit every collection whose element type is not primitive, enumerations included.

The default, because it is what §7.4.3.5 says and what Cyclone DDS emits.

§

EnumIsPrimitive

Treat an enumeration as if it were primitive, and delimit the rest.

What Fast DDS emits. Select it to interoperate with a Fast DDS peer over a topic whose type has an enum collection.

§

Never

Never delimit a collection, whatever its element type.

What RTI Connext 7.7 emits. Element-level delimiters an @appendable element type calls for are still written; this policy is only about the collection’s own.

Implementations§

Source§

impl CollectionDelimiterPolicy

Source

pub const ALL: [Self; 3]

Every policy.

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 in a wire-affecting setting must be loud.

Trait Implementations§

Source§

impl Clone for CollectionDelimiterPolicy

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 CollectionDelimiterPolicy

Source§

impl Debug for CollectionDelimiterPolicy

Source§

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

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

impl Default for CollectionDelimiterPolicy

Source§

fn default() -> Self

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

impl Eq for CollectionDelimiterPolicy

Source§

impl Hash for CollectionDelimiterPolicy

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 CollectionDelimiterPolicy

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 CollectionDelimiterPolicy

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 CollectionDelimiterPolicy

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 CollectionDelimiterPolicy

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.