diff --git a/src/lib.rs b/src/lib.rs index 653ec4b..021d826 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,33 @@ #![warn(missing_docs)] //! Library to parse JUnit XML files +//! +//! # Example +//! +//! Parsing a JUnit content +//! +//! ``` +//! use std::io::Cursor; +//! let xml = r#" +//! +//! +//! +//! +//! details about failure +//! +//! +//! "#; +//! let cursor = Cursor::new(xml); +//! let r = junit_parser::from_reader(cursor); +//! assert!(r.is_ok()); +//! let t = r.unwrap(); +//! assert_eq!(t.suites.len(), 1); +//! let ts = &t.suites[0]; +//! assert_eq!(ts.tests, 3); +//! assert_eq!(ts.failures, 1); +//! assert_eq!(ts.cases.len(), 3); +//! assert!(ts.cases[0].status.is_success()); +//! assert!(ts.cases[2].status.is_failure()); +//! ``` /// Errors mod errors;