Struct WString 

pub struct WString(pub String);

IDL wstring wrapper. Holds the text as a Rust String (Unicode), but the wire format differs from string: GIOP 1.2 encodes a wstring as a uint32 length in octets (NOT characters, NOT incl. terminator) followed by the UTF-16 code units in the message byte order — without a null terminator. This makes wstring distinct from string (UTF-8) and interop-capable with ORBs whose transmission codeset is UTF-16 (the default for omniORB/TAO/JacORB).

Tuple Fields

0: String

Implementations

impl WString

pub fn as_str(&self) -> &str

Borrows the inner text.

pub fn encode_with_bom( &self, writer: &mut BufferWriter, with_bom: bool, ) -> Result<(), EncodeError>

Encodes the GIOP 1.2 wstring with an explicit BOM choice, bypassing the global corba_wstring_bom policy. with_bom = true = omniORB/TAO form (a 0xFEFF byte-order mark prepended, counted in the octet length); false = JacORB form (no BOM, units in message byte order). An empty wstring is length 0 either way.

Errors

ValueOutOfRange if the octet length exceeds u32::MAX.

Trait Implementations

impl CdrDecode for WString

fn decode(reader: &mut BufferReader<'_>) -> Result<Self, DecodeError>

Reads this value from the reader (alignment-aware).

const IS_PRIMITIVE: bool = false

XCDR2 primitive classification, symmetric to CdrEncode::IS_PRIMITIVE. Controls DHEADER reading when decoding sequence<T>/T[N] with non-primitive T.

impl CdrEncode for WString

fn encode(&self, writer: &mut BufferWriter) -> Result<(), EncodeError>

Writes this value into the writer (alignment-aware).

const IS_PRIMITIVE: bool = false

XCDR2 primitive classification (OMG XTypes 1.3 §7.4.3.5): true only for primitives (bool, octet, int8/16/32/64, uint8/16/32/64, float, double, char/wchar). false for aggregate/variable types (string, struct, union, enum, sequence, array, map). Controls DHEADER prepending for sequence<T>/T[N]: collections with NON-primitive elements need a DHEADER (uint32 = byte length of the following content) under XCDR2.

impl Clone for WString

fn clone(&self) -> WString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WString

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

Formats the value using the given formatter.

impl Default for WString

fn default() -> WString

Returns the “default value” for a type.

impl Eq for WString

impl From<&str> for WString

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for WString

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for WString

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 WString

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

impl PartialEq for WString

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

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