Struct ReadOptions

pub struct ReadOptions {
    pub empty_text_node: bool,
    pub trim_text: bool,
    pub ignore_whitespace_only: bool,
    pub require_decl: bool,
    pub encoding: Option<String>,
}

Options when parsing xml.

Fields

empty_text_node: bool

will have a Node::Text(“”) as its children, while won’t. Default: true

trim_text: bool

Trims leading and ending whitespaces in Node::Text, and ignore node if it is empty. Default: true

ignore_whitespace_only: bool

Ignore Node::Text that only has whitespaces. Only makes sense if trim_text is false. (If both are true, performance takes a hit for no gain) Default: false

require_decl: bool

Returns error if document doesn’t start with XML declaration. If there is no XML declaration, the parser won’t be able to decode encodings other than UTF-8, unless encoding below is set. Default: true

encoding: Option<String>

If this is set, the parser will start reading with this encoding. But it will switch to XML declaration’s encoding value if it has a different value. See encoding_rs::Encoding::for_label for valid values. Default: None

Implementations

impl ReadOptions

pub fn default() -> ReadOptions

Create ReadOptions with default options.

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> ReadOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadOptions

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

Formats the value using the given formatter.

impl PartialEq for ReadOptions

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

impl StructuralPartialEq for ReadOptions