tinyxml2 1.0.0

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

//! Integration tests for `NodeRef` and `ElementRef` typed reference wrappers.

use tinyxml2::{Document, NodeKind};

// --- NodeRef tests ---

#[test]
fn node_ref_kind() {
    let doc = Document::parse("<root/>").unwrap();
    let node = doc.node_ref(doc.root()).unwrap();
    assert!(matches!(node.kind(), NodeKind::Document));
}

#[test]
fn node_ref_value_element() {
    let doc = Document::parse("<root/>").unwrap();
    let root_el = doc.node_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(root_el.value(), "root");
}

#[test]
fn node_ref_value_text() {
    let doc = Document::parse("<root>hello world</root>").unwrap();
    let root_el = doc.root_element().unwrap();
    let text_node = doc.children(root_el).next().unwrap();
    assert_eq!(text_node.value(), "hello world");
}

#[test]
fn node_ref_value_comment() {
    let doc = Document::parse("<root><!-- my comment --></root>").unwrap();
    let root_el = doc.root_element().unwrap();
    let comment_node = doc.children(root_el).next().unwrap();
    assert_eq!(comment_node.value(), " my comment ");
}

#[test]
fn node_ref_value_document() {
    let doc = Document::parse("<root/>").unwrap();
    let node = doc.node_ref(doc.root()).unwrap();
    assert_eq!(node.value(), "");
}

#[test]
fn node_ref_parent() {
    let doc = Document::parse("<root><child/></root>").unwrap();
    let root_el = doc.root_element().unwrap();
    let child = doc.children(root_el).next().unwrap();
    let parent = child.parent().unwrap();
    assert_eq!(parent.id(), root_el);
}

#[test]
fn node_ref_parent_of_root_is_none() {
    let doc = Document::parse("<root/>").unwrap();
    let doc_node = doc.node_ref(doc.root()).unwrap();
    assert!(doc_node.parent().is_none());
}

#[test]
fn node_ref_children_iteration() {
    let doc = Document::parse("<root><a/><b/><c/></root>").unwrap();
    let root_el = doc.node_ref(doc.root_element().unwrap()).unwrap();
    let names: Vec<&str> = root_el.children().map(|n| n.value()).collect();
    assert_eq!(names, vec!["a", "b", "c"]);
}

#[test]
fn node_ref_line_number() {
    let doc = Document::parse("<root/>").unwrap();
    let root_el = doc.node_ref(doc.root_element().unwrap()).unwrap();
    // Line number should be non-zero for parsed nodes
    assert!(root_el.line() > 0);
}

#[test]
fn node_ref_as_element_success() {
    let doc = Document::parse("<root/>").unwrap();
    let node = doc.node_ref(doc.root_element().unwrap()).unwrap();
    let el = node.as_element();
    assert!(el.is_some());
    assert_eq!(el.unwrap().name(), "root");
}

#[test]
fn node_ref_as_element_failure_on_text() {
    let doc = Document::parse("<root>text</root>").unwrap();
    let root_el = doc.root_element().unwrap();
    let text = doc.children(root_el).next().unwrap();
    assert!(text.as_element().is_none());
}

#[test]
fn node_ref_as_element_failure_on_document() {
    let doc = Document::parse("<root/>").unwrap();
    let doc_node = doc.node_ref(doc.root()).unwrap();
    assert!(doc_node.as_element().is_none());
}

#[test]
fn node_ref_siblings() {
    let doc = Document::parse("<root><a/><b/><c/></root>").unwrap();
    let root_el = doc.root_element().unwrap();
    let a = doc.children(root_el).next().unwrap();
    let sibling_names: Vec<&str> = a.siblings().map(|n| n.value()).collect();
    assert_eq!(sibling_names, vec!["b", "c"]);
}

#[test]
fn node_ref_descendants() {
    let doc = Document::parse("<root><a><a1/></a><b/></root>").unwrap();
    let root_el = doc.node_ref(doc.root_element().unwrap()).unwrap();
    let names: Vec<&str> = root_el.descendants().map(|n| n.value()).collect();
    assert_eq!(names, vec!["a", "a1", "b"]);
}

#[test]
fn node_ref_equality() {
    let doc = Document::parse("<root/>").unwrap();
    let n1 = doc.node_ref(doc.root()).unwrap();
    let n2 = doc.node_ref(doc.root()).unwrap();
    assert_eq!(n1, n2);
}

#[test]
fn node_ref_is_copy() {
    let doc = Document::parse("<root/>").unwrap();
    let n1 = doc.node_ref(doc.root()).unwrap();
    let n2 = n1; // copy
    assert_eq!(n1, n2);
}

#[test]
fn node_ref_document_accessor() {
    let doc = Document::parse("<root/>").unwrap();
    let node = doc.node_ref(doc.root()).unwrap();
    assert_eq!(node.document().root(), doc.root());
}

// --- ElementRef tests ---

#[test]
fn element_ref_name() {
    let doc = Document::parse("<myelem/>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el.name(), "myelem");
}

#[test]
fn element_ref_attribute() {
    let doc = Document::parse(r#"<root key="value"/>"#).unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el.attribute("key"), Some("value"));
    assert_eq!(el.attribute("missing"), None);
}

#[test]
fn element_ref_attributes_iteration() {
    let doc = Document::parse(r#"<root a="1" b="2" c="3"/>"#).unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let attrs: Vec<(&str, &str)> = el.attributes().collect();
    assert_eq!(attrs, vec![("a", "1"), ("b", "2"), ("c", "3")]);
}

#[test]
fn element_ref_text() {
    let doc = Document::parse("<root>hello</root>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el.text(), Some("hello"));
}

#[test]
fn element_ref_text_none_when_empty() {
    let doc = Document::parse("<root/>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el.text(), None);
}

#[test]
fn element_ref_children() {
    let doc = Document::parse("<root><a/><b/></root>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let count = el.children().count();
    assert_eq!(count, 2);
}

#[test]
fn element_ref_child_elements() {
    let doc = Document::parse("<root><a/>text<b/></root>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let names: Vec<&str> = el.child_elements().map(|e| e.name()).collect();
    assert_eq!(names, vec!["a", "b"]);
}

#[test]
fn element_ref_child_elements_by_name() {
    let doc = Document::parse("<root><x/><y/><x/></root>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let count = el.child_elements_by_name("x").count();
    assert_eq!(count, 2);
}

#[test]
fn element_ref_int_attribute() {
    let doc = Document::parse(r#"<root count="42"/>"#).unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el.int_attribute("count", 0), 42);
    assert_eq!(el.int_attribute("missing", -1), -1);
}

#[test]
fn element_ref_bool_attribute() {
    let doc = Document::parse(r#"<root enabled="true"/>"#).unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert!(el.bool_attribute("enabled", false));
    assert!(!el.bool_attribute("missing", false));
}

#[test]
fn element_ref_double_attribute() {
    let doc = Document::parse(r#"<root ratio="1.61803"/>"#).unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let val = el.double_attribute("ratio", 0.0);
    assert!((val - 1.61803).abs() < 1e-10);
    assert!((el.double_attribute("missing", 99.5) - 99.5).abs() < 1e-10);
}

#[test]
fn element_ref_as_node_roundtrip() {
    let doc = Document::parse("<root/>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let node = el.as_node();
    let el2 = node.as_element().unwrap();
    assert_eq!(el.id(), el2.id());
}

#[test]
fn element_ref_is_copy() {
    let doc = Document::parse("<root/>").unwrap();
    let el1 = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let el2 = el1; // copy
    assert_eq!(el1, el2);
}

#[test]
fn element_ref_from_non_element_returns_none() {
    let doc = Document::parse("<root/>").unwrap();
    // Document root node is not an Element
    assert!(doc.element_ref(doc.root()).is_none());
}

#[test]
fn element_ref_document_accessor() {
    let doc = Document::parse("<root/>").unwrap();
    let el = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el.document().root(), doc.root());
}

#[test]
fn element_ref_equality() {
    let doc = Document::parse("<root/>").unwrap();
    let el1 = doc.element_ref(doc.root_element().unwrap()).unwrap();
    let el2 = doc.element_ref(doc.root_element().unwrap()).unwrap();
    assert_eq!(el1, el2);
}

#[test]
fn node_ref_invalid_id_returns_none() {
    let mut doc = Document::parse("<root><child/></root>").unwrap();
    let root_el = doc.root_element().unwrap();
    let child_id = doc.first_child(root_el).unwrap();
    // Delete the child, making the id stale
    doc.delete_child(root_el, child_id).unwrap();
    // node_ref should return None for stale IDs
    assert!(doc.node_ref(child_id).is_none());
}