Struct DecodedText 

pub struct DecodedText { /* private fields */ }

The result of decoding a byte stream: either recovered text in a known TextEncoding, or the original bytes preserved verbatim because they could not be decoded.

Construct one with DecodedText::decode; it never loses data and DecodedText::encode reproduces the input.

Implementations

impl DecodedText

pub fn decode(bytes: &[u8]) -> Self

Decode bytes, sniffing a leading byte-order mark to pick the encoding. Valid UTF-8 or UTF-16 is recovered as text; anything that fails to decode is preserved verbatim with an OpaqueReason. Never fails and never loses data.

pub fn encoding(&self) -> TextEncoding

The encoding this text was decoded as, or TextEncoding::OpaqueBytes when the input could not be decoded.

pub fn as_str(&self) -> Option<&str>

The decoded text, or None when the input was kept opaque (see Self::opaque_reason).

pub fn opaque_reason(&self) -> Option<OpaqueReason>

Why the input was kept opaque, or None when it decoded as text.

pub fn encode(&self) -> Vec<u8>

Re-encode back to bytes in the original encoding (re-adding any BOM). For opaque input this returns the preserved original bytes, so decode-then-encode is always a faithful round-trip.

pub fn map_text(&self, edit: impl FnOnce(&str) -> String) -> Self

Apply edit to the decoded text, keeping the original encoding. Opaque input is returned unchanged, so transformations never run on bytes that could not be understood as text.

Trait Implementations

impl Clone for DecodedText

fn clone(&self) -> DecodedText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodedText

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

Formats the value using the given formatter.

impl Eq for DecodedText

impl PartialEq for DecodedText

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecodedText