minidom/
lib.rs

1// Copyright (c) 2020 lumi <lumi@pew.im>
2// Copyright (c) 2020 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
3// Copyright (c) 2020 Bastien Orivel <eijebong+minidom@bananium.fr>
4// Copyright (c) 2020 Astro <astro@spaceboyz.net>
5// Copyright (c) 2020 Maxime “pep” Buquet <pep@bouah.net>
6//
7// This Source Code Form is subject to the terms of the Mozilla Public
8// License, v. 2.0. If a copy of the MPL was not distributed with this
9// file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
11#![deny(missing_docs)]
12#![cfg_attr(docsrs, feature(doc_auto_cfg))]
13
14//! A minimal DOM crate built on top of rxml, targeting exclusively the subset of XML useful
15//! for XMPP.
16//!
17//! This library exports an `Element` struct which represents a DOM tree.
18//!
19//! # Example
20//!
21//! Run with `cargo run --example articles`. Located in `examples/articles.rs`.
22//!
23//! ```rust
24//! extern crate minidom;
25//!
26//! use minidom::Element;
27//!
28//! const DATA: &'static str = r#"<articles xmlns="article">
29//!     <article>
30//!         <title>10 Terrible Bugs You Would NEVER Believe Happened</title>
31//!         <body>
32//!             Rust fixed them all. &lt;3
33//!         </body>
34//!     </article>
35//!     <article>
36//!         <title>BREAKING NEWS: Physical Bug Jumps Out Of Programmer's Screen</title>
37//!         <body>
38//!             Just kidding!
39//!         </body>
40//!     </article>
41//! </articles>"#;
42//!
43//! const ARTICLE_NS: &'static str = "article";
44//!
45//! #[derive(Debug)]
46//! pub struct Article {
47//!     title: String,
48//!     body: String,
49//! }
50//!
51//! fn main() {
52//!     let root: Element = DATA.parse().unwrap();
53//!
54//!     let mut articles: Vec<Article> = Vec::new();
55//!
56//!     for child in root.children() {
57//!         if child.is("article", ARTICLE_NS) {
58//!             let title = child.get_child("title", ARTICLE_NS).unwrap().text();
59//!             let body = child.get_child("body", ARTICLE_NS).unwrap().text();
60//!             articles.push(Article {
61//!                 title: title,
62//!                 body: body.trim().to_owned(),
63//!             });
64//!         }
65//!     }
66//!
67//!     println!("{:?}", articles);
68//! }
69//! ```
70//!
71//! # Usage
72//!
73//! To use `minidom`, add this to your `Cargo.toml` under `dependencies`:
74//!
75//! ```toml,ignore
76//! minidom = "*"
77//! ```
78
79extern crate alloc;
80
81pub mod convert;
82pub mod element;
83pub mod error;
84mod namespaces;
85pub mod node;
86mod prefixes;
87pub mod tree_builder;
88
89#[cfg(test)]
90mod tests;
91
92pub use convert::IntoAttributeValue;
93pub use element::{Children, ChildrenMut, Element, ElementBuilder};
94pub use error::{Error, Result};
95pub use namespaces::NSChoice;
96pub use node::Node;
minidom/lib.rs

minidom/
lib.rs
