Crate exile

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:

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

Not Supported:

• Entities
• Entity References
• Doctypes
• Comment Parsing
• 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);
    }
}

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>

Modules

error	The public error type for this library.
parser	This module is responsible for parsing XML from string representations.

Structs

Declaration	The XML declaration at the start of the XML Document.
Document	Represents an XML Document.
Element	Represents an Element in an XML Document.
PI	Represents a Processing Instruction (PI) in an XML document.
ParseError	Represents an error that occurred during parsing because the XML document is not well-formed.
WriteOpts	Options for controlling how the XML Document is written when serialized.

Enums

Encoding	The encoding of the XML Document, currently only UTF-8 is supported.
Misc	Represents a "Misc" entry, which is a Processing Instruction (PI), Comment, or Whitespace
Node	Represents a Node in an XML Document. The Document consists of a recursive nesting of these.
Version	Represents the XML Version being used.

Functions

load	Load a document from a file.
parse	Parse an XML file held in string contents.