#xml #xml-parser #writer #reader #parser #reader-writer

biodivine-xml-doc

Read, modify and write xml in tree-like structure. Supports UTF-16.

1 unstable release

0.3.0 May 15, 2024

#2686 in Parser implementations

26 downloads per month

MIT/Apache

88KB
1.5K SLoC

Biodivine/xml-doc

This is a fork of the original xml-doc crate, which is now obsolete. It fixes some minor issues and introduces new APIs for easier manipulation of XML elements with namespaces.

xml-doc is a rust library to read, modify, and write XML documents. Documentation

It's aim is to be able to read any xml files, and modify only the parts you want to.

Features:

  • Supports reading from most encodings, including UTF-16. (With the notable exception of UTF-32)
  • You can have references to the parts of the tree, and still mutate the tree.
  • Elements stores reference to its parent element, so traveling up the tree is fast.
  • One of the fastest XML tree-like parser & writer. See #Performance.
  • Supports attribute value normalization, character/entity references.

Due to its architecture, you can't exchange nodes or elements between documents. If your project modifies multiple xml documents at the same time, this library may not be a good fit.

Example

use biodivine_xml_doc::{Document, Element};

let XML = r#"<?xml version="1.0"?>
<package xmlns:dc="http://purl.org/dc/elements/1.1/">
    <metadata>
        <dc:title>xml-doc</dc:title>
        <dc:rights>MIT or Apache 2.0</dc:rights>
    </metadata>
</package>
"#;

let doc = Document::parse_str(XML).unwrap();
let package = doc.root_element().unwrap();
let metadata = package.find(&doc, "metadata").unwrap();
let title = metadata.find(&doc, "title").unwrap();
title.set_attribute("xml:lang", "en");

// Add an element to metadata: <dc:creator id="author">Yoonchae Lee</dc:creator>
let author = Element::build("dc:creator")
    .text_content("Yoonchae Lee")
    .attribute("id", "author")
    .push_to(&mut doc, metadata);

let new_xml = doc.write_str();

Performance

To run benchmark: cd benches ; cargo bench.

Tree-based Parser

                   tiny(5KB) medium(1.5MB) large(25MB) medium(UTF-16)
xml-doc v0.2.0:     81.02us     31.08ms      355.04ms      33.33ms
minidom v0.12.0:    94.93us     43.39ms      610.41ms
roxmltree v0.14.1:  52.73us     17.23ms      353.79ms
xmltree v0.10.3:  4305.7 us   1355.0 ms    22769.  ms

Only roxmltree which doesn't support writing, is considerably faster than xml_doc. (Benchmark results).

Event-based parser

This crate uses [quick-xml] to parse/write xml, which seems to be the fastest xml event parser. (Benchmark results).

                   tiny(5KB) medium(1.5MB) large(25MB)
quick-xml v0.17.2:  21.11us     6.63ms       97.79ms
xml-rs v0.8.4:     343.56us    96.17ms     1671.8 ms
xml5ever v0.16.2:  127.83us    42.46ms      550.83ms
RustyXML v0.3.0:   103.07us    36.40ms      710.93ms

Dependencies

~4.5MB
~141K SLoC