Enum WstringUnitOrder 

pub enum WstringUnitOrder {
    Stream,
    BigEndianAlways,
    ByteOrderMark,
    HostUnswapped,
}

In what byte order a wstring’s code units go out — C4.

The byte-layer half of zerodds_ast_layout::WstringUnitOrder, which carries the runs. Read by Writer::write_wstring and Reader::read_wstring for a wstring’s units, and by Writer::write_wchar for a scalar, where CORBA gives the mark no place to ride and Self::ByteOrderMark therefore degrades to big-endian.

A fourth axis and not a fourth coordinate of WstringLengthPolicy: it crosses the length convention rather than extending it. omniORB’s mark rides on an octet count and nothing stops a GIOP 1.1 character count from carrying one too, so folding the order in would give eight variants for two questions — which is how UnswappedUnits, a byte order wearing a length policy’s name, came to exist.

Variants

Stream

The stream’s own byte order. XTypes §7.4.1.1.2 through ESWAP.

BigEndianAlways

UTF-16 big-endian whatever the stream says. What omniORB and JacORB decode in the absence of a byte-order mark.

ByteOrderMark

A byte-order mark, then the units, both little-endian. omniORB.

HostUnswapped

The units always little-endian, no mark. Cyclone’s big-endian output, and rosidl_typesupport_fastrtps’s over four-octet units. Arrived as a value of the length policy — a byte order wearing a length’s name — and belongs on this axis.

Implementations

impl WstringUnitOrder

pub const fn has_mark(self) -> bool

Whether a byte-order mark is written, and expected on read.

The mark is a code unit like any other and its octets are counted in the length: omniORB writes 0a000000 fffe 6100 34d8 1edd 6200 for "a𝄞b", ten octets over five units. §7.4.1.1.2 forbids it outright — “shall not include a Byte Order Mark” — so no DDS dialect selects it.

pub const fn writes_little_endian_units(self, _position: WirePosition) -> bool

Whether one code unit goes out little-endian whatever the stream’s order is.

Takes the position for the reason WstringLengthPolicy’s accessors do. Measured to agree at the member and the collection element in all nine implementations.

Trait Implementations

impl Clone for WstringUnitOrder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WstringUnitOrder

impl Debug for WstringUnitOrder

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

Formats the value using the given formatter.

impl Default for WstringUnitOrder

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WstringUnitOrder

impl Hash for WstringUnitOrder

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WstringUnitOrder

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

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.

impl PartialEq for WstringUnitOrder

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WstringUnitOrder

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