Make modules reader and writer public

All examples updated to use more explicit names

Author: Mingun

Changelog.md

@@ -188,6 +188,9 @@
 
 - [#455]: Removed `Reader::read_text_into` which is only not a better wrapper over match on `Event::Text`
 
+- [#456]: Reader and writer stuff grouped under `reader` and `writer` modules.
+  You still can use re-exported definitions from a crate root
+
 ### New Tests
 
 - [#9]: Added tests for incorrect nested tags in input
@@ -230,6 +233,7 @@
 [#445]: https://github.com/tafia/quick-xml/pull/445
 [#450]: https://github.com/tafia/quick-xml/pull/450
 [#455]: https://github.com/tafia/quick-xml/pull/455
+[#456]: https://github.com/tafia/quick-xml/pull/456
 
 
 ## 0.23.0 -- 2022-05-08

README.md

@@ -19,8 +19,8 @@ Syntax is inspired by [xml-rs](https://github.com/netvl/xml-rs).
 ### Reader
 
 ```rust
-use quick_xml::Reader;
 use quick_xml::events::Event;
+use quick_xml::reader::Reader;
 
 let xml = r#"<tag1 att1 = "test">
                 <tag2><!--Test comment-->Test</tag2>
@@ -66,7 +66,8 @@ loop {
 
 ```rust
 use quick_xml::events::{Event, BytesEnd, BytesStart};
-use quick_xml::{Reader, Writer};
+use quick_xml::reader::Reader;
+use quick_xml::writer::Writer;
 use std::io::Cursor;
 
 let xml = r#"<this_tag k1="v1" k2="v2"><child>text</child></this_tag>"#;

benches/macrobenches.rs

@@ -1,7 +1,7 @@
 use criterion::{self, criterion_group, criterion_main, Criterion, Throughput};
 use quick_xml::events::Event;
+use quick_xml::reader::{NsReader, Reader};
 use quick_xml::Result as XmlResult;
-use quick_xml::{NsReader, Reader};
 
 static RPM_PRIMARY: &str = include_str!("../tests/documents/rpm_primary.xml");
 static RPM_PRIMARY2: &str = include_str!("../tests/documents/rpm_primary2.xml");

benches/microbenches.rs

@@ -3,7 +3,7 @@ use pretty_assertions::assert_eq;
 use quick_xml::escape::{escape, unescape};
 use quick_xml::events::Event;
 use quick_xml::name::QName;
-use quick_xml::{NsReader, Reader};
+use quick_xml::reader::{NsReader, Reader};
 
 static SAMPLE: &str = include_str!("../tests/documents/sample_rss.xml");
 static PLAYERS: &str = include_str!("../tests/documents/players.xml");

compare/benches/bench.rs

@@ -1,6 +1,7 @@
 use criterion::{self, criterion_group, criterion_main, BenchmarkId, Criterion, Throughput};
 use pretty_assertions::assert_eq;
-use quick_xml::{self, events::Event, Reader};
+use quick_xml::events::Event;
+use quick_xml::reader::Reader;
 use serde::Deserialize;
 use serde_xml_rs;
 use xml::reader::{EventReader, XmlEvent};

examples/custom_entities.rs

@@ -10,7 +10,7 @@
 use std::collections::HashMap;
 
 use quick_xml::events::Event;
-use quick_xml::Reader;
+use quick_xml::reader::Reader;
 use regex::bytes::Regex;
 
 const DATA: &str = r#"

examples/nested_readers.rs

@@ -1,6 +1,6 @@
 use pretty_assertions::assert_eq;
 use quick_xml::events::Event;
-use quick_xml::Reader;
+use quick_xml::reader::Reader;
 
 // a structure to capture the rows we've extracted
 // from a ECMA-376 table in document.xml

examples/read_buffered.rs

@@ -5,7 +5,7 @@
 
 fn main() -> Result<(), quick_xml::Error> {
     use quick_xml::events::Event;
-    use quick_xml::Reader;
+    use quick_xml::reader::Reader;
 
     let mut reader = Reader::from_file("tests/documents/document.xml")?;
     reader.trim_text(true);

examples/read_texts.rs

@@ -1,6 +1,6 @@
 fn main() {
     use quick_xml::events::Event;
-    use quick_xml::Reader;
+    use quick_xml::reader::Reader;
 
     let xml = "<tag1>text1</tag1><tag1>text2</tag1>\
                <tag1>text3</tag1><tag1><tag2>text4</tag2></tag1>";

fuzz/fuzz_targets/fuzz_target_1.rs

@@ -1,8 +1,8 @@
 #![no_main]
 #[macro_use] extern crate libfuzzer_sys;
 
-use quick_xml::Reader;
 use quick_xml::events::Event;
+use quick_xml::reader::Reader;
 use std::io::Cursor;
 
 fuzz_target!(|data: &[u8]| {