High performance xml pull reader/writer.
- is almost zero-copy (use of
- is easy on memory allocation (the API provides a way to reuse buffers)
- support various encoding (with
encodingfeature), namespaces resolution, special characters.
Syntax is inspired by xml-rs.
use Event; use Reader; let xml = r#"<tag1 att1 = "test"> <tag2><!--Test comment-->Test</tag2> <tag2>Test 2</tag2> </tag1>"#; let mut reader = from_str; reader.trim_text; let mut count = 0; let mut txt = Vecnew; let mut buf = Vecnew; // The `Reader` does not implement `Iterator` because it outputs borrowed data (`Cow`s) loop
use ; use Reader; use Writer; use Cursor; let xml = r#"<this_tag k1="v1" k2="v2"><child>text</child></this_tag>"#; let mut reader = from_str; reader.trim_text; let mut writer = new; loop let result = writer.into_inner.into_inner; let expected = r#"<my_elem k1="v1" k2="v2" my-key="some value"><child>text</child></my_elem>"#; assert_eq!;
When using the
serialize feature, quick-xml can be used with serde's
The mapping between XML and Rust types, and in particular the syntax that allows you to specify the
distinction between elements and attributes, is described in detail in the documentation
This has largely been inspired by serde-xml-rs.
quick-xml follows its convention for deserialization, including the
$value special name.
Parsing the "value" of a tag
If you have an input of the form
<foo abc="xyz">bar</foo>, and you want to get at the
you can use either the special name
$text, or the special name
Read about the difference in the documentation.
Note that despite not focusing on performance (there are several unnecessary copies), it remains about 10x faster than serde-xml-rs.
encoding: support non utf8 xmls
serialize: support serde
Benchmarking is hard and the results depend on your input file and your machine.
Here on my particular file, quick-xml is around 50 times faster than xml-rs crate.
// quick-xml benches test bench_quick_xml ... bench: 198,866 ns/iter (+/- 9,663) test bench_quick_xml_escaped ... bench: 282,740 ns/iter (+/- 61,625) test bench_quick_xml_namespaced ... bench: 389,977 ns/iter (+/- 32,045) // same bench with xml-rs test bench_xml_rs ... bench: 14,468,930 ns/iter (+/- 321,171) // serde-xml-rs vs serialize feature test bench_serde_quick_xml ... bench: 1,181,198 ns/iter (+/- 138,290) test bench_serde_xml_rs ... bench: 15,039,564 ns/iter (+/- 783,485)
For a feature and performance comparison, you can also have a look at RazrFalcon's parser comparison table.
Any PR is welcomed!