xmpp-rs/src/lib.rs

#![deny(missing_docs)]

//! A minimal DOM crate built on top of quick-xml.
//!
//! This library exports an `Element` struct which represents a DOM tree.
//!
//! # Example
//!
//! Run with `cargo run --example articles`. Located in `examples/articles.rs`.
//!
//! ```rust,ignore
//! extern crate minidom;
//!
//! use minidom::Element;
//!
//! const DATA: &'static str = r#"<articles xmlns="article">
//!     <article>
//!         <title>10 Terrible Bugs You Would NEVER Believe Happened</title>
//!         <body>
//!             Rust fixed them all. &lt;3
//!         </body>
//!     </article>
//!     <article>
//!         <title>BREAKING NEWS: Physical Bug Jumps Out Of Programmer's Screen</title>
//!         <body>
//!             Just kidding!
//!         </body>
//!     </article>
//! </articles>"#;
//!
//! const ARTICLE_NS: &'static str = "article";
//!
//! #[derive(Debug)]
//! pub struct Article {
//!     title: String,
//!     body: String,
//! }
//!
//! fn main() {
//!     let root: Element = DATA.parse().unwrap();
//!
//!     let mut articles: Vec<Article> = Vec::new();
//!
//!     for child in root.children() {
//!         if child.is("article", ARTICLE_NS) {
//!             let title = child.get_child("title", ARTICLE_NS).unwrap().text();
//!             let body = child.get_child("body", ARTICLE_NS).unwrap().text();
//!             articles.push(Article {
//!                 title: title,
//!                 body: body.trim().to_owned(),
//!             });
//!         }
//!     }
//!
//!     println!("{:?}", articles);
//! }
//! ```
//!
//! # Usage
//!
//! To use `minidom`, add this to your `Cargo.toml` under `dependencies`:
//!
//! ```toml,ignore
//! minidom = "*"
//! ```

extern crate quick_xml;

pub mod error;
pub mod element;
pub mod convert;
pub mod node;
mod namespace_set;

#[cfg(test)] mod tests;

pub use error::{Error, Result};
pub use element::{Element, Children, ChildrenMut, ElementBuilder};
pub use node::Node;
pub use convert::IntoAttributeValue;
overhauling the library, made tests pass 2017-03-08 19:34:17 +00:00			`#![deny(missing_docs)]`

Fix doc to reflect the switch from xml-rs to quick-xml. 2018-06-23 12:06:18 +00:00			`//! A minimal DOM crate built on top of quick-xml.`
document all the things! 2017-02-21 14:46:06 +00:00			`//!`
			//! This library exports an `Element` struct which represents a DOM tree.
			`//!`
			`//! # Example`
			`//!`
			//! Run with `cargo run --example articles`. Located in `examples/articles.rs`.
			`//!`
			//! ```rust,ignore
			`//! extern crate minidom;`
			`//!`
			`//! use minidom::Element;`
			`//!`
			`//! const DATA: &'static str = r#"<articles xmlns="article">`
			`//! <article>`
			`//! <title>10 Terrible Bugs You Would NEVER Believe Happened</title>`
			`//! <body>`
			`//! Rust fixed them all. <3`
			`//! </body>`
			`//! </article>`
			`//! <article>`
			`//! <title>BREAKING NEWS: Physical Bug Jumps Out Of Programmer's Screen</title>`
			`//! <body>`
			`//! Just kidding!`
			`//! </body>`
			`//! </article>`
			`//! </articles>"#;`
			`//!`
			`//! const ARTICLE_NS: &'static str = "article";`
			`//!`
			`//! #[derive(Debug)]`
			`//! pub struct Article {`
			`//! title: String,`
			`//! body: String,`
			`//! }`
			`//!`
			`//! fn main() {`
			`//! let root: Element = DATA.parse().unwrap();`
			`//!`
			`//! let mut articles: Vec<Article> = Vec::new();`
			`//!`
			`//! for child in root.children() {`
			`//! if child.is("article", ARTICLE_NS) {`
			`//! let title = child.get_child("title", ARTICLE_NS).unwrap().text();`
			`//! let body = child.get_child("body", ARTICLE_NS).unwrap().text();`
			`//! articles.push(Article {`
			`//! title: title,`
			`//! body: body.trim().to_owned(),`
			`//! });`
			`//! }`
			`//! }`
			`//!`
			`//! println!("{:?}", articles);`
			`//! }`
			//! ```
			`//!`
			`//! # Usage`
			`//!`
added documentation url and fixed a dumb mistake 2017-02-25 14:43:56 +00:00			//! To use `minidom`, add this to your `Cargo.toml` under `dependencies`:
document all the things! 2017-02-21 14:46:06 +00:00			`//!`
			//! ```toml,ignore
added documentation url and fixed a dumb mistake 2017-02-25 14:43:56 +00:00			`//! minidom = "*"`
document all the things! 2017-02-21 14:46:06 +00:00			//! ```

Replace xml-rs by quick_xml quick_xml is way faster than xml-rs Here is an example with a quick atom parser: With xml-rs: test parse_factorio_atom ... bench: 3,295,678 ns/iter (+/- 165,851) With quick_xml: test parse_factorio_atom ... bench: 203,215 ns/iter (+/- 13,485) Unfortunately I had to break the API for this change to happen. * Element::from_reader now takes `R: BufRead` instead of `R: Read` * Element::write_to now takes `W: io::Write` instead of `EventWriter<W: Write>` This migration also allow us to have a write_to function which assumes we're already in a given namespace (see `write_to_in_namespace`). 2017-06-07 20:40:53 +00:00			`extern crate quick_xml;`
initial commit 2017-02-19 19:46:44 +00:00
overhauling the library, made tests pass 2017-03-08 19:34:17 +00:00			`pub mod error;`
			`pub mod element;`
			`pub mod convert;`
Split `Node` off into its own module: `node.rs` 2018-12-23 14:59:13 +00:00			`pub mod node;`
rename namespaces mod to namespace_set 2017-08-13 15:29:38 +00:00			`mod namespace_set;`
initial commit 2017-02-19 19:46:44 +00:00
overhauling the library, made tests pass 2017-03-08 19:34:17 +00:00			`#[cfg(test)] mod tests;`
initial commit 2017-02-19 19:46:44 +00:00
update quick_xml and migrate from error-chain to failure 2018-02-18 18:54:09 +00:00			`pub use error::{Error, Result};`
Split `Node` off into its own module: `node.rs` 2018-12-23 14:59:13 +00:00			`pub use element::{Element, Children, ChildrenMut, ElementBuilder};`
			`pub use node::Node;`
Get rid of `IntoElements`, replace it with `Into<Node>` and `<T: Into<Node> IntoIterator<Item = T>`. This is a backwards-incompatible change, but should require minimal changes. Doing this splits the `append` method in `ElementBuilder` into two methods. `append` now appends exactly one node, while `append_all` appends an iterator of nodes. Add `remove_child`, which removes the first child that has a specific name and namespace, then returns it if it exists. Add a lot of convenience methods on `Node`: `as_text_mut`, `as_element_mut`, `into_text`, `into_element`. 2018-12-23 14:40:23 +00:00			`pub use convert::IntoAttributeValue;`