Crate xot

Xot is an XML library that lets you access manipulate XML documents as a tree in memory.

use xot::Xot;

let mut xot = Xot::new();

let root = xot.parse("<p>Example</p>")?;
let doc_el = xot.document_element(root)?;
let txt = xot.first_child(doc_el).unwrap();
let txt_value = xot.text_mut(txt).unwrap();
txt_value.set("Hello, world!");

assert_eq!(xot.to_string(root)?, "<p>Hello, world!</p>");

Xot approach

Xot exposes a single Xot struct that you use to access, create and manipulate all your XML data. Multiple XML trees can exist in an Xot struct at the same time, and you’re free to move nodes between these trees.

Node is a lightweight handle to a node in the XML tree that you use with Xot for both access and manipulation. To navigate the tree use accessors such as Xot::first_child or iterators such a Xot::children. You then use operations such as Xot::append to manipulate the tree.

To access and manipulate XML specific data, you use the Value for a node. This is an enum that’s either an Element, Text, Comment or ProcessingInstruction, or Root (which has no value). You can use Xot::value to get the Value. Sometimes it’s more handy to use the specific accessors for a value, such a Xot::element or Xot::text.

XML names and namespaces in Xot are referenced by ids. In order to construct or compare an element, you first need to get hold of a name. To access a name, use Xot::name. To create a new name if necessary, use Xot::add_name.

Modules

• fixed
  A static representation of a tree of nodes.
• proptest
  Proptest support for Xot

Structs

• Comment
  XML comment.
• Element
  XML element value.
• NameId
  Id uniquely identifying a name and namespace.
• NamespaceId
  Id uniquely identifying namespace.
• Node
  A node in the XML tree. This is a lightweight value and can be copied.
• OutputToken
  Output token
• PrefixId
  Id uniquely identifying a prefix
• PrettyOutputToken
  Pretty output token
• ProcessingInstruction
  XML processing instruction value.
• SerializeOptions
  Options to control serialization
• Text
  XML text value.
• WithSerializeOptions
  Configurable serialization
• Xot
  The Xot struct manages all XML tree data in your program. It lets you access and manipulate one or more XML documents and fragments.

Enums

• Error
  Xot errors
• LevelOrder
  Node in level order
• NodeEdge
  Node edges.
• Output
  Output of serialization
• Value
  An XML value.
• ValueType
  The type of the XML node.

Type Aliases

• Attributes
  A map of NameId to String for attributes
• Prefixes
  A map of PrefixId to NamespaceId for namespace declarations.