Struct quick_xml::encoding::Decoder

pub struct Decoder { /* private fields */ }

Decoder of byte slices into strings.

If feature encoding is enabled, this encoding taken from the "encoding" XML declaration or assumes UTF-8, if XML has no declaration, encoding key is not defined or contains unknown encoding.

The library supports any UTF-8 compatible encodings that crate encoding_rs is supported. UTF-16 and ISO-2022-JP are not supported at the present.

If feature encoding is disabled, the decoder is always UTF-8 decoder: any XML declarations are ignored.

Implementations

impl Decoder

pub const fn encoding(&self) -> &'static Encoding

Available on crate feature encoding only.

Returns the Readers encoding.

This encoding will be used by decode.

pub fn decode<'b>(&self, bytes: &'b [u8]) -> Result<Cow<'b, str>>

Without encoding feature

Decodes an UTF-8 slice regardless of XML declaration and ignoring BOM if it is present in the bytes.

With encoding feature

Decodes specified bytes using encoding, declared in the XML, if it was declared there, or UTF-8 otherwise, and ignoring BOM if it is present in the bytes.

---

Returns an error in case of malformed sequences in the bytes.

pub fn decode_into(&self, bytes: &[u8], buf: &mut String) -> Result<()>

Like decode but using a pre-allocated buffer.

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Decoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decoder

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

Formats the value using the given formatter.

impl PartialEq for Decoder

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

impl Eq for Decoder

impl StructuralPartialEq for Decoder