# xml5ever
 
[](https://docs.rs/xml5ever)
[](https://crates.io/crates/xml5ever)
[API documentation](https://Ygg01.github.io/docs/xml5ever/xml5ever/index.html)
**Warning:** This library is alpha quality, so no guarantees are given.
This crate provides a push based XML parser library that trades well-formedness for error recovery.
xml5ever is based largely on [html5ever](https://github.com/servo/html5ever) parser, so if you have experience with html5ever you will be familiar with xml5ever.
The library is dual licensed under MIT and Apache license.
# Why you should use xml5ever
Main use case for this library is when XML is badly formatted, usually from bad XML
templates. XML5 tries to handle most common errors, in a manner similar to HTML5.
## When you should use it?
- You aren't interested in well-formed documents.
- You need to get some info from your data even if it has errors (although not all possible errors are handled).
- You want to features like character references or xml namespaces.
## When you shouldn't use it
- You need to have your document validated.
- You require DTD support.
- You require an easy to use parser, with lots of extensions (e.g. XPath, XQuery).
- You require a battle tested, industry proven solution.
# Installation
Add xml5ever as a dependency in your project manifest.
```toml
[dependencies]
xml5ever = "0.1.3"
```
And add crate declaration in your lib.rs
```rust
extern crate xml5ever
```
# Getting started
Here is a very simple RcDom backed parser:
```rust
let input = "<xml></xml>".to_tendril();
// To parse XML into a tree form, we need a TreeSink
// luckily xml5ever comes with a static RC backed tree represetation.
let dom: RcDom = parse(std::iter::once(input), Default::default());
// Do something with dom
```
The thing that does actual parsing is the `parse` function. It expects an iterator that can be converted into `StrTendril`, so you can use `std::iter::once(input)` or `Some(input).into_iter()` (where `input` is `StrTendril` like structure).
# Working on xml5ever
To build examples and tests you need to do something along the lines of:
```rust
git submodule update --init # to fetch xml5lib-tests
cargo build
cargo test
```
This will fetch tests from outside repository and it will invoke cargo to
build and test the crate. If you need docs checkout either [API docs](https://ygg01.github.io/docs/xml5ever/xml5ever/index.html) or run `cargo docs`
to generate documentation.
## Easy first tasks
What I generally recommend is to look at Clippy Linting badge results and create
a PR for fixing the said lints. Other than that try to look for any tasks labeled
easy or just update docs/examples.