Struct ParseOptions 

pub struct ParseOptions {
    pub process_entities: bool,
    pub whitespace: Whitespace,
    pub max_depth: u32,
}

Options for parsing XML documents.

Replaces TinyXML2’s XMLDocument constructor parameters with a builder-style options struct for clarity and extensibility.

Examples

use tinyxml2::{ParseOptions, Whitespace};

let opts = ParseOptions::new()
    .with_whitespace(Whitespace::Collapse)
    .with_process_entities(false)
    .with_max_depth(100);

Fields

process_entities: bool

Whether to process XML entities during parsing.

When true (default), entity references like & are decoded. When false, entity text is preserved as-is.

whitespace: Whitespace

Whitespace handling mode.

max_depth: u32

Maximum allowed element nesting depth.

Prevents stack overflow on deeply nested (potentially malicious) input. Default is 500, matching TinyXML2’s TINYXML2_MAX_ELEMENT_DEPTH.

Implementations

impl ParseOptions

pub const fn new() -> Self

Creates default parse options.

• process_entities: true
• whitespace: Whitespace::Preserve
• max_depth: 500

pub const fn with_whitespace(self, whitespace: Whitespace) -> Self

Sets the whitespace handling mode.

pub const fn with_process_entities(self, process: bool) -> Self

Sets whether entities should be processed during parsing.

pub const fn with_max_depth(self, depth: u32) -> Self

Sets the maximum element nesting depth.

Trait Implementations

impl Clone for ParseOptions

fn clone(&self) -> ParseOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseOptions

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

Formats the value using the given formatter.

impl Default for ParseOptions

fn default() -> Self

Returns the “default value” for a type.