tinyxml2 0.1.14

A ground-up Rust implementation of the TinyXML2 API — behavioral compatibility, idiomatic internals
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! XML DOM node types.

use crate::arena::NodeId;

/// An XML attribute name-value pair.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Attribute {
    /// The name of the attribute.
    pub name: String,
    /// The value of the attribute.
    pub value: String,
}

/// Node-specific data for XML elements.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ElementData {
    /// The tag name of the element.
    pub name: String,
    /// The attributes of the element.
    pub attributes: Vec<Attribute>,
}

/// Node-specific data for text nodes.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TextData {
    /// The text content.
    pub content: String,
    /// Whether the text was parsed as a CDATA section.
    pub is_cdata: bool,
}

/// The kind of XML node.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NodeKind {
    /// The top-level document node.
    Document,
    /// An XML element (e.g., `<element name="value">`).
    Element(ElementData),
    /// A text node or CDATA section.
    Text(TextData),
    /// A comment (e.g., `<!-- comment -->`).
    Comment(String),
    /// An XML declaration (e.g., `<?xml version="1.0"?>`).
    Declaration(ElementData),
    /// An unrecognized structure (e.g., `<!DOCTYPE ...>`).
    Unknown(String),
}

/// Represents a single node's data in the DOM tree, including tree linkages.
#[derive(Debug, Clone)]
pub struct NodeData {
    /// The specific kind and data of this node.
    pub kind: NodeKind,
    /// The parent node.
    pub parent: Option<NodeId>,
    /// The first child node.
    pub first_child: Option<NodeId>,
    /// The last child node.
    pub last_child: Option<NodeId>,
    /// The previous sibling node.
    pub prev_sibling: Option<NodeId>,
    /// The next sibling node.
    pub next_sibling: Option<NodeId>,
    /// The 1-based source line number where this node was parsed.
    pub line_num: u32,
}

impl NodeData {
    /// Creates a new, detached `NodeData` with the specified kind and line number.
    #[must_use]
    pub const fn new(kind: NodeKind, line_num: u32) -> Self {
        Self {
            kind,
            parent: None,
            first_child: None,
            last_child: None,
            prev_sibling: None,
            next_sibling: None,
            line_num,
        }
    }
}