| de |
|
|
| encoding.rs |
A module for wrappers that encode / decode data. |
5935 |
| errors.rs |
Error management module |
13250 |
| escapei.rs |
Manage xml character escapes |
69901 |
| events |
|
|
| lib.rs |
High performance XML reader/writer.
# Description
quick-xml contains two modes of operation:
A streaming API based on the [StAX] model. This is suited for larger XML documents which
cannot completely read into memory at once.
The user has to explicitly _ask_ for the next XML event, similar to a database cursor.
This is achieved by the following two structs:
- [`Reader`]: A low level XML pull-reader where buffer allocation/clearing is left to user.
- [`Writer`]: A XML writer. Can be nested with readers if you want to transform XMLs.
Especially for nested XML elements, the user must keep track _where_ (how deep)
in the XML document the current event is located.
quick-xml contains optional support of asynchronous reading and writing using [tokio].
To get it enable the [`async-tokio`](#async-tokio) feature.
Furthermore, quick-xml also contains optional [Serde] support to directly
serialize and deserialize from structs, without having to deal with the XML events.
To get it enable the [`serialize`](#serialize) feature. Read more about mapping Rust types
to XML in the documentation of [`de`] module. Also check [`serde_helpers`]
module.
# Examples
- For a reading example see [`Reader`]
- For a writing example see [`Writer`]
# Features
`quick-xml` supports the following features:
[StAX]: https://en.wikipedia.org/wiki/StAX
[tokio]: https://tokio.rs/
[Serde]: https://serde.rs/
[`de`]: ./de/index.html |
2842 |
| name.rs |
Module for handling names according to the W3C [Namespaces in XML 1.1 (Second Edition)][spec]
specification
[spec]: https://www.w3.org/TR/xml-names11 |
44625 |
| reader |
|
|
| se |
|
|
| serde_helpers.rs |
Provides helper functions to glue an XML with a serde content model. |
11749 |
| utils.rs |
|
6895 |
| writer |
|
|
| writer.rs |
Contains high-level interface for an events-based XML emitter. |
26274 |