fastxml 0.8.1

A fast, memory-efficient XML library with XPath and XSD validation support
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
//! Profiling utilities for memory and performance measurement.

use std::path::Path;
use std::time::{Duration, Instant};

use crate::document::XmlDocument;
use crate::error::Result;

/// Profile result containing timing and memory statistics.
#[derive(Debug, Clone)]
pub struct ProfileResult {
    /// Time taken to parse the XML.
    pub parse_time: Duration,
    /// Peak memory usage (if available).
    pub memory_peak: Option<usize>,
    /// Current memory usage after parsing.
    pub memory_current: Option<usize>,
    /// Number of nodes in the document.
    pub node_count: usize,
    /// File size in bytes.
    pub file_size: usize,
    /// Time for XPath evaluation (if measured).
    pub xpath_eval_time: Option<Duration>,
    /// Additional metrics.
    pub metrics: ProfileMetrics,
}

impl ProfileResult {
    /// Returns nodes per second parsing rate.
    pub fn nodes_per_second(&self) -> f64 {
        let secs = self.parse_time.as_secs_f64();
        if secs > 0.0 {
            self.node_count as f64 / secs
        } else {
            0.0
        }
    }

    /// Returns bytes per second parsing rate.
    pub fn bytes_per_second(&self) -> f64 {
        let secs = self.parse_time.as_secs_f64();
        if secs > 0.0 {
            self.file_size as f64 / secs
        } else {
            0.0
        }
    }

    /// Returns memory per node ratio.
    pub fn memory_per_node(&self) -> Option<f64> {
        self.memory_current.map(|mem| {
            if self.node_count > 0 {
                mem as f64 / self.node_count as f64
            } else {
                0.0
            }
        })
    }
}

impl std::fmt::Display for ProfileResult {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "Profile Results:")?;
        writeln!(f, "  File size:      {} bytes", self.file_size)?;
        writeln!(f, "  Parse time:     {:?}", self.parse_time)?;
        writeln!(f, "  Node count:     {}", self.node_count)?;
        writeln!(
            f,
            "  Parse rate:     {:.0} nodes/sec",
            self.nodes_per_second()
        )?;
        writeln!(
            f,
            "  Throughput:     {:.2} MB/sec",
            self.bytes_per_second() / 1_000_000.0
        )?;

        if let Some(mem) = self.memory_current {
            writeln!(
                f,
                "  Memory used:    {} bytes ({:.2} MB)",
                mem,
                mem as f64 / 1_000_000.0
            )?;
        }

        if let Some(mem_per_node) = self.memory_per_node() {
            writeln!(f, "  Memory/node:    {:.1} bytes", mem_per_node)?;
        }

        if let Some(xpath_time) = self.xpath_eval_time {
            writeln!(f, "  XPath eval:     {:?}", xpath_time)?;
        }

        Ok(())
    }
}

/// Additional profiling metrics.
#[derive(Debug, Clone, Default)]
pub struct ProfileMetrics {
    /// Number of element nodes.
    pub element_count: usize,
    /// Number of text nodes.
    pub text_count: usize,
    /// Number of attributes.
    pub attribute_count: usize,
    /// Maximum tree depth.
    pub max_depth: usize,
    /// Number of distinct element names.
    pub distinct_elements: usize,
    /// Number of namespace declarations.
    pub namespace_count: usize,
}

/// Gets current memory usage.
#[cfg(feature = "profile")]
pub fn get_memory_usage() -> Option<usize> {
    memory_stats::memory_stats().map(|stats| stats.physical_mem)
}

/// Gets current memory usage (stub when profile feature is disabled).
#[cfg(not(feature = "profile"))]
pub fn get_memory_usage() -> Option<usize> {
    None
}

/// Profiles parsing a file.
pub fn profile_file(path: &Path) -> Result<ProfileResult> {
    use crate::{parse, xpath};

    let file_size = std::fs::metadata(path)?.len() as usize;
    let content = std::fs::read(path)?;

    let memory_before = get_memory_usage();
    let start = Instant::now();

    let doc = parse(&content)?;

    let parse_time = start.elapsed();
    let memory_after = get_memory_usage();

    let memory_current = match (memory_before, memory_after) {
        (Some(before), Some(after)) => Some(after.saturating_sub(before)),
        (None, Some(after)) => Some(after),
        _ => None,
    };

    // Collect metrics
    let metrics = collect_metrics(&doc);
    let node_count = doc.node_count();

    // Measure XPath evaluation
    let xpath_start = Instant::now();
    let _ = xpath::evaluate(&doc, "//*");
    let xpath_eval_time = Some(xpath_start.elapsed());

    Ok(ProfileResult {
        parse_time,
        memory_peak: None, // Would need more sophisticated tracking
        memory_current,
        node_count,
        file_size,
        xpath_eval_time,
        metrics,
    })
}

/// Profiles parsing XML content.
pub fn profile_content(content: &[u8]) -> Result<ProfileResult> {
    use crate::{parse, xpath};

    let file_size = content.len();

    let memory_before = get_memory_usage();
    let start = Instant::now();

    let doc = parse(content)?;

    let parse_time = start.elapsed();
    let memory_after = get_memory_usage();

    let memory_current = match (memory_before, memory_after) {
        (Some(before), Some(after)) => Some(after.saturating_sub(before)),
        (None, Some(after)) => Some(after),
        _ => None,
    };

    let metrics = collect_metrics(&doc);
    let node_count = doc.node_count();

    // Measure XPath evaluation
    let xpath_start = Instant::now();
    let _ = xpath::evaluate(&doc, "//*");
    let xpath_eval_time = Some(xpath_start.elapsed());

    Ok(ProfileResult {
        parse_time,
        memory_peak: None,
        memory_current,
        node_count,
        file_size,
        xpath_eval_time,
        metrics,
    })
}

/// Collects detailed metrics from a document.
fn collect_metrics(doc: &XmlDocument) -> ProfileMetrics {
    use crate::node::NodeType;
    use std::collections::HashSet;

    let mut metrics = ProfileMetrics::default();
    let mut element_names = HashSet::new();

    fn visit(
        node: &crate::node::XmlNode,
        depth: usize,
        metrics: &mut ProfileMetrics,
        element_names: &mut HashSet<String>,
    ) {
        match node.get_type() {
            NodeType::Element => {
                metrics.element_count += 1;
                element_names.insert(node.qname());
                metrics.attribute_count += node.get_attributes().len();
                metrics.namespace_count += node.get_namespace_declarations().len();
            }
            NodeType::Text => {
                metrics.text_count += 1;
            }
            _ => {}
        }

        metrics.max_depth = metrics.max_depth.max(depth);

        for child in node.get_child_nodes() {
            visit(&child, depth + 1, metrics, element_names);
        }
    }

    if let Ok(root) = doc.get_root_element() {
        visit(&root, 1, &mut metrics, &mut element_names);
    }

    metrics.distinct_elements = element_names.len();
    metrics
}

/// Benchmark helper for comparing performance.
pub struct Benchmark {
    iterations: usize,
    results: Vec<Duration>,
}

impl Benchmark {
    /// Creates a new benchmark.
    pub fn new(iterations: usize) -> Self {
        Self {
            iterations,
            results: Vec::with_capacity(iterations),
        }
    }

    /// Runs a benchmark function.
    pub fn run<F>(&mut self, mut f: F) -> &Self
    where
        F: FnMut(),
    {
        self.results.clear();
        for _ in 0..self.iterations {
            let start = Instant::now();
            f();
            self.results.push(start.elapsed());
        }
        self
    }

    /// Returns the minimum time.
    pub fn min(&self) -> Duration {
        self.results.iter().cloned().min().unwrap_or_default()
    }

    /// Returns the maximum time.
    pub fn max(&self) -> Duration {
        self.results.iter().cloned().max().unwrap_or_default()
    }

    /// Returns the average time.
    pub fn avg(&self) -> Duration {
        if self.results.is_empty() {
            Duration::default()
        } else {
            let sum: Duration = self.results.iter().sum();
            sum / self.results.len() as u32
        }
    }

    /// Returns the median time.
    pub fn median(&self) -> Duration {
        if self.results.is_empty() {
            return Duration::default();
        }
        let mut sorted = self.results.clone();
        sorted.sort();
        sorted[sorted.len() / 2]
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_profile_content() {
        let xml = r#"<root><child attr="value">text</child></root>"#;
        let result = profile_content(xml.as_bytes()).unwrap();

        assert!(result.parse_time > Duration::ZERO);
        assert_eq!(result.file_size, xml.len());
        assert!(result.node_count > 0);
        assert_eq!(result.metrics.element_count, 2); // root + child
        assert_eq!(result.metrics.attribute_count, 1);
    }

    #[test]
    fn test_benchmark() {
        let mut bench = Benchmark::new(3);
        bench.run(|| {
            std::thread::sleep(std::time::Duration::from_millis(1));
        });

        assert!(bench.min() >= Duration::from_millis(1));
        assert!(bench.avg() >= Duration::from_millis(1));
    }

    // ProfileResult tests
    #[test]
    fn test_profile_result_nodes_per_second() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: None,
            memory_current: None,
            node_count: 1000,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.nodes_per_second(), 1000.0);
    }

    #[test]
    fn test_profile_result_nodes_per_second_zero_time() {
        let result = ProfileResult {
            parse_time: Duration::ZERO,
            memory_peak: None,
            memory_current: None,
            node_count: 1000,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.nodes_per_second(), 0.0);
    }

    #[test]
    fn test_profile_result_bytes_per_second() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: None,
            memory_current: None,
            node_count: 1000,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.bytes_per_second(), 5000.0);
    }

    #[test]
    fn test_profile_result_bytes_per_second_zero_time() {
        let result = ProfileResult {
            parse_time: Duration::ZERO,
            memory_peak: None,
            memory_current: None,
            node_count: 1000,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.bytes_per_second(), 0.0);
    }

    #[test]
    fn test_profile_result_memory_per_node() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: None,
            memory_current: Some(10000),
            node_count: 100,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.memory_per_node(), Some(100.0));
    }

    #[test]
    fn test_profile_result_memory_per_node_none() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: None,
            memory_current: None,
            node_count: 100,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.memory_per_node(), None);
    }

    #[test]
    fn test_profile_result_memory_per_node_zero_nodes() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: None,
            memory_current: Some(10000),
            node_count: 0,
            file_size: 5000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        assert_eq!(result.memory_per_node(), Some(0.0));
    }

    #[test]
    fn test_profile_result_display() {
        let result = ProfileResult {
            parse_time: Duration::from_millis(100),
            memory_peak: None,
            memory_current: Some(1000000),
            node_count: 500,
            file_size: 50000,
            xpath_eval_time: Some(Duration::from_millis(10)),
            metrics: ProfileMetrics::default(),
        };
        let display = format!("{}", result);
        assert!(display.contains("Profile Results:"));
        assert!(display.contains("File size:"));
        assert!(display.contains("Parse time:"));
        assert!(display.contains("Node count:"));
        assert!(display.contains("Memory used:"));
        assert!(display.contains("Memory/node:"));
        assert!(display.contains("XPath eval:"));
    }

    #[test]
    fn test_profile_result_display_no_memory() {
        let result = ProfileResult {
            parse_time: Duration::from_millis(100),
            memory_peak: None,
            memory_current: None,
            node_count: 500,
            file_size: 50000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        let display = format!("{}", result);
        assert!(display.contains("Profile Results:"));
        assert!(!display.contains("Memory used:"));
        assert!(!display.contains("XPath eval:"));
    }

    #[test]
    fn test_profile_result_clone() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: Some(100),
            memory_current: Some(200),
            node_count: 50,
            file_size: 1000,
            xpath_eval_time: Some(Duration::from_millis(5)),
            metrics: ProfileMetrics::default(),
        };
        let cloned = result.clone();
        assert_eq!(cloned.node_count, result.node_count);
        assert_eq!(cloned.file_size, result.file_size);
    }

    #[test]
    fn test_profile_result_debug() {
        let result = ProfileResult {
            parse_time: Duration::from_secs(1),
            memory_peak: None,
            memory_current: None,
            node_count: 50,
            file_size: 1000,
            xpath_eval_time: None,
            metrics: ProfileMetrics::default(),
        };
        let debug = format!("{:?}", result);
        assert!(debug.contains("ProfileResult"));
    }

    // ProfileMetrics tests
    #[test]
    fn test_profile_metrics_default() {
        let metrics = ProfileMetrics::default();
        assert_eq!(metrics.element_count, 0);
        assert_eq!(metrics.text_count, 0);
        assert_eq!(metrics.attribute_count, 0);
        assert_eq!(metrics.max_depth, 0);
        assert_eq!(metrics.distinct_elements, 0);
        assert_eq!(metrics.namespace_count, 0);
    }

    #[test]
    fn test_profile_metrics_clone() {
        let metrics = ProfileMetrics {
            element_count: 10,
            text_count: 5,
            attribute_count: 3,
            max_depth: 4,
            distinct_elements: 2,
            namespace_count: 1,
        };
        let cloned = metrics.clone();
        assert_eq!(cloned.element_count, 10);
        assert_eq!(cloned.text_count, 5);
    }

    #[test]
    fn test_profile_metrics_debug() {
        let metrics = ProfileMetrics::default();
        let debug = format!("{:?}", metrics);
        assert!(debug.contains("ProfileMetrics"));
    }

    // Benchmark tests
    #[test]
    fn test_benchmark_new() {
        let bench = Benchmark::new(5);
        assert_eq!(bench.iterations, 5);
        assert!(bench.results.is_empty());
    }

    #[test]
    fn test_benchmark_max() {
        let mut bench = Benchmark::new(3);
        bench.run(|| {
            std::thread::sleep(std::time::Duration::from_millis(1));
        });
        assert!(bench.max() >= Duration::from_millis(1));
    }

    #[test]
    fn test_benchmark_median() {
        let mut bench = Benchmark::new(3);
        bench.run(|| {
            std::thread::sleep(std::time::Duration::from_millis(1));
        });
        assert!(bench.median() >= Duration::from_millis(1));
    }

    #[test]
    fn test_benchmark_empty_results() {
        let bench = Benchmark::new(3);
        assert_eq!(bench.min(), Duration::default());
        assert_eq!(bench.max(), Duration::default());
        assert_eq!(bench.avg(), Duration::default());
        assert_eq!(bench.median(), Duration::default());
    }

    #[test]
    fn test_benchmark_run_clears_results() {
        let mut bench = Benchmark::new(2);
        bench.run(|| {});
        assert_eq!(bench.results.len(), 2);
        bench.run(|| {});
        assert_eq!(bench.results.len(), 2);
    }

    // get_memory_usage test
    #[test]
    fn test_get_memory_usage() {
        // Just verify it doesn't panic
        let _ = get_memory_usage();
    }

    // profile_content additional tests
    #[test]
    fn test_profile_content_with_namespaces() {
        let xml = r#"<root xmlns:ns="http://example.com"><ns:child/></root>"#;
        let result = profile_content(xml.as_bytes()).unwrap();
        assert!(result.metrics.namespace_count >= 1);
    }

    #[test]
    fn test_profile_content_nested() {
        let xml = r#"<root><a><b><c><d/></c></b></a></root>"#;
        let result = profile_content(xml.as_bytes()).unwrap();
        assert!(result.metrics.max_depth >= 4);
        assert_eq!(result.metrics.element_count, 5);
    }

    #[test]
    fn test_profile_content_text_nodes() {
        let xml = r#"<root>text1<child>text2</child>text3</root>"#;
        let result = profile_content(xml.as_bytes()).unwrap();
        assert!(result.metrics.text_count >= 2);
    }

    #[test]
    fn test_profile_content_distinct_elements() {
        let xml = r#"<root><a/><b/><a/><c/></root>"#;
        let result = profile_content(xml.as_bytes()).unwrap();
        // root, a, b, c = 4 distinct elements
        assert_eq!(result.metrics.distinct_elements, 4);
    }

    #[test]
    fn test_profile_content_xpath_eval_time() {
        let xml = r#"<root><child/></root>"#;
        let result = profile_content(xml.as_bytes()).unwrap();
        assert!(result.xpath_eval_time.is_some());
    }
}