Skip to content

Latest commit

 

History

History
81 lines (63 loc) · 1.75 KB

README.md

File metadata and controls

81 lines (63 loc) · 1.75 KB

exile

Current version: 0.0.9

build

exile is a Rust library for reading and writing XML.

The goal, at least initially, is to provide an abstract syntax tree of an XML file. As such, this is a Exile is a dom parser and loads the complete contents of the document into memory.

Currently supported:

  • Attributes
  • CDATA Sections
  • Comment Parsing
  • Elements
  • Processing Instructions
  • Text Nodes
  • UTF-8
  • Whitespace Normalization

Not Supported:

  • Doctypes
  • Entities
  • Entity References
  • Other Encodings
  • Whitesace Preservation: All text nodes are treated as if whitespace collapse were in-effect.

Example

Parsing XML looks like this.

let xml = r#"
<root>
  <thing name="foo"/>
  <thing>bar</thing>
</root>
"#;

let doc = exile::parse(xml).unwrap();
for child in doc.root().children() {
    println!("element name: {}", child.name());
    if let Some(attribute) = child.attribute("name") {
        println!("name attribute: {}", attribute);
    }
}

// we can create an index of elements
let index = doc.index();

// the element at index 2 is <thing>bar</thing>
let thing = index.element(2).unwrap();

// the parent of index 2 is <root>
let root = index.parent(&thing).unwrap();

assert_eq!("bar", thing.text().unwrap());
assert_eq!("root", root.name());

Authoring XML looks like this.

use exile::{Document, Element, Node};
let mut root = Element::from_name("my_root");
root.add_attribute("foo", "bar");
let mut child = Element::from_name("my_child");
child.add_text("Hello World!");
root.add_child(child);
let doc = Document::from_root(root);
println!("{}", doc.to_string());

The above program prints:

<my_root foo="bar">
  <my_child>Hello World!</my_child>
</my_root>