Struct DecodedUtf16 

#[non_exhaustive]
pub struct DecodedUtf16 {
    pub text: String,
    pub unpaired_surrogates: usize,
    pub dangling_byte: bool,
}

A decoded UTF-16 string together with what decoding it cost.

text is always well-formed UTF-8 — every unpaired surrogate half is replaced with U+FFFD — so a caller may ignore the rest. The remaining fields say what the replacement concealed, because a decode that lost information should be able to report it rather than hand back a plausible-looking string.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

The decoded text. Unpaired surrogate halves appear as U+FFFD.

unpaired_surrogates: usize

How many unpaired surrogate halves were replaced with U+FFFD in text.

dangling_byte: bool

The input had an odd length, so a trailing byte could not form a code unit and was dropped. Reported for the input as a whole, whatever the NUL policy — an odd-length UTF-16 field is a structural anomaly worth surfacing even when the dropped byte fell past a terminator.

Implementations

impl DecodedUtf16

pub fn is_lossy(&self) -> bool

Whether anything was lost: an unpaired surrogate, a dangling byte, or both.

Trait Implementations

impl Clone for DecodedUtf16

fn clone(&self) -> DecodedUtf16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodedUtf16

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

Formats the value using the given formatter.

impl Eq for DecodedUtf16

impl PartialEq for DecodedUtf16

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecodedUtf16