Detach from parent project and rename crate to fast-xml

Author: Mingun

Cargo.toml

@@ -1,20 +1,16 @@
 [package]
-name = "quick-xml"
+name = "fast-xml"
 version = "0.23.0-alpha3"
-authors = ["Johann Tuffe <[email protected]>"]
 description = "High performance xml reader and writer"
 edition = "2018"
 
-documentation = "https://docs.rs/quick-xml"
-repository = "https://github.com/tafia/quick-xml"
+documentation = "https://docs.rs/fast-xml"
+repository = "https://github.com/Mingun/fast-xml"
 
-keywords = ["xml", "reader", "parser", "writer", "html"]
-categories = ["encoding", "parsing", "text-processing"]
+keywords = ["xml", "serde", "parser", "writer", "html"]
+categories = ["encoding", "parsing", "parser-implementations"]
 license = "MIT"
 
-[badges]
-travis-ci = { repository = "tafia/quick-xml" }
-
 [dependencies]
 encoding_rs = { version = "0.8.26", optional = true }
 serde = { version = "1.0", optional = true }

README.md

@@ -1,7 +1,7 @@
-# quick-xml
+# fast-xml -- successor of [quick-xml]
 
-![status](https://github.com/tafia/quick-xml/actions/workflows/rust.yml/badge.svg)
-[![Crate](https://img.shields.io/crates/v/quick-xml.svg)](https://crates.io/crates/quick-xml)
+![status](https://github.com/Mingun/fast-xml/actions/workflows/rust.yml/badge.svg)
+[![Crate](https://img.shields.io/crates/v/fast-xml.svg)](https://crates.io/crates/fast-xml)
 
 High performance xml pull reader/writer.
 
@@ -10,17 +10,27 @@ The reader:
 - is easy on memory allocation (the API provides a way to reuse buffers)
 - support various encoding (with `encoding` feature), namespaces resolution, special characters.
 
-[docs.rs](https://docs.rs/quick-xml)
+[docs.rs](https://docs.rs/fast-xml)
 
 Syntax is inspired by [xml-rs](https://github.com/netvl/xml-rs).
 
+## Migration from [quick-xml]
+
+If you using quick-xml 0.22.0 or 0.23.0-alpha3, you can just replace `quick-xml`
+in your `Cargo.toml` with `fast-xml`. Replace each occurrence of `quick_xml`
+crate name to `fast_xml` in your code base.
+
+That two releases of fast-xml was specifically made for migration and contains
+the same code as original quick-xml, except updated cargo metadata and extern
+crate names in tests, benches and examples.
+
 ## Example
 
 ### Reader
 
 ```rust
-use quick_xml::Reader;
-use quick_xml::events::Event;
+use fast_xml::Reader;
+use fast_xml::events::Event;
 
 let xml = r#"<tag1 att1 = "test">
                 <tag2><!--Test comment-->Test</tag2>
@@ -64,9 +74,9 @@ loop {
 ### Writer
 
 ```rust
-use quick_xml::Writer;
-use quick_xml::Reader;
-use quick_xml::events::{Event, BytesEnd, BytesStart};
+use fast_xml::Writer;
+use fast_xml::Reader;
+use fast_xml::events::{Event, BytesEnd, BytesStart};
 use std::io::Cursor;
 use std::iter;
 
@@ -110,20 +120,20 @@ assert_eq!(result, expected.as_bytes());
 
 ## Serde
 
-When using the `serialize` feature, quick-xml can be used with serde's `Serialize`/`Deserialize` traits.
+When using the `serialize` feature, fast-xml can be used with serde's `Serialize`/`Deserialize` traits.
 
 Here is an example deserializing crates.io source:
 
 ```rust
 // Cargo.toml
 // [dependencies]
 // serde = { version = "1.0", features = [ "derive" ] }
-// quick-xml = { version = "0.21", features = [ "serialize" ] }
+// fast-xml = { version = "0.22", features = [ "serialize" ] }
 extern crate serde;
-extern crate quick_xml;
+extern crate fast_xml;
 
 use serde::Deserialize;
-use quick_xml::de::{from_str, DeError};
+use fast_xml::de::{from_str, DeError};
 
 #[derive(Debug, Deserialize, PartialEq)]
 struct Link {
@@ -213,10 +223,12 @@ fn crates_io() -> Result<Html, DeError> {
 
 ### Credits
 
-This has largely been inspired by [serde-xml-rs](https://github.com/RReverser/serde-xml-rs). 
-quick-xml follows its convention for deserialization, including the 
+This has largely been inspired by [serde-xml-rs](https://github.com/RReverser/serde-xml-rs).
+fast-xml follows its convention for deserialization, including the
 [`$value`](https://github.com/RReverser/serde-xml-rs#parsing-the-value-of-a-tag) special name.
 
+Original [quick-xml] was developed by @tafia and abandoned around end of 2021.
+
 ### Parsing the "value" of a tag
 
 If you have an input of the form `<foo abc="xyz">bar</foo>`, and you want to get at the `bar`, you can use the special name `$value`:
@@ -262,7 +274,7 @@ Serializing `Root { foo: Foo::Bar }` will then yield `<Root foo="Bar"/>` instead
 
 ### Performance
 
-Note that despite not focusing on performance (there are several unecessary copies), it remains about 10x faster than serde-xml-rs.
+Note that despite not focusing on performance (there are several unnecessary copies), it remains about 10x faster than serde-xml-rs.
 
 # Features
 
@@ -273,7 +285,8 @@ Note that despite not focusing on performance (there are several unecessary copi
 
 Benchmarking is hard and the results depend on your input file and your machine.
 
-Here on my particular file, quick-xml is around **50 times faster** than [xml-rs](https://crates.io/crates/xml-rs) crate.
+Here on my particular file, fast-xml is around **50 times faster** than [xml-rs](https://crates.io/crates/xml-rs) crate.
+_(measurements was done while this crate named quick-xml)_
 
 ```
 // quick-xml benches
@@ -298,3 +311,5 @@ Any PR is welcomed!
 ## License
 
 MIT
+
+[quick-xml]: https://github.com/tafia/quick-xml

benches/bench.rs

@@ -1,14 +1,14 @@
 #![feature(test)]
 
-extern crate quick_xml;
+extern crate fast_xml;
 extern crate test;
 
-use quick_xml::events::Event;
-use quick_xml::Reader;
+use fast_xml::events::Event;
+use fast_xml::Reader;
 use test::Bencher;
 
 #[bench]
-fn bench_quick_xml_normal(b: &mut Bencher) {
+fn bench_fast_xml_normal(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../tests/sample_rss.xml");
     b.iter(|| {
         let mut r = Reader::from_reader(src);
@@ -28,7 +28,7 @@ fn bench_quick_xml_normal(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_namespaced(b: &mut Bencher) {
+fn bench_fast_xml_namespaced(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../tests/sample_rss.xml");
     b.iter(|| {
         let mut r = Reader::from_reader(src);
@@ -49,7 +49,7 @@ fn bench_quick_xml_namespaced(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_escaped(b: &mut Bencher) {
+fn bench_fast_xml_escaped(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../tests/sample_rss.xml");
     b.iter(|| {
         let mut buf = Vec::new();
@@ -78,7 +78,7 @@ fn bench_quick_xml_escaped(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_normal_trimmed(b: &mut Bencher) {
+fn bench_fast_xml_normal_trimmed(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../tests/sample_rss.xml");
     b.iter(|| {
         let mut r = Reader::from_reader(src);
@@ -100,7 +100,7 @@ fn bench_quick_xml_normal_trimmed(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_namespaced_trimmed(b: &mut Bencher) {
+fn bench_fast_xml_namespaced_trimmed(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../tests/sample_rss.xml");
     b.iter(|| {
         let mut r = Reader::from_reader(src);
@@ -123,7 +123,7 @@ fn bench_quick_xml_namespaced_trimmed(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_escaped_trimmed(b: &mut Bencher) {
+fn bench_fast_xml_escaped_trimmed(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../tests/sample_rss.xml");
     b.iter(|| {
         let mut buf = Vec::new();
@@ -154,7 +154,7 @@ fn bench_quick_xml_escaped_trimmed(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_one_text_event(b: &mut Bencher) {
+fn bench_fast_xml_one_text_event(b: &mut Bencher) {
     let src = "Hello world!".repeat(512 / 12).into_bytes();
     let mut buf = Vec::with_capacity(1024);
     b.iter(|| {
@@ -173,7 +173,7 @@ fn bench_quick_xml_one_text_event(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_one_start_event_trimmed(b: &mut Bencher) {
+fn bench_fast_xml_one_start_event_trimmed(b: &mut Bencher) {
     let src = format!(r#"<hello target="{}">"#, "world".repeat(512 / 5)).into_bytes();
     let mut buf = Vec::with_capacity(1024);
     b.iter(|| {
@@ -194,7 +194,7 @@ fn bench_quick_xml_one_start_event_trimmed(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_one_comment_event_trimmed(b: &mut Bencher) {
+fn bench_fast_xml_one_comment_event_trimmed(b: &mut Bencher) {
     let src = format!(r#"<!-- hello "{}" -->"#, "world".repeat(512 / 5)).into_bytes();
     let mut buf = Vec::with_capacity(1024);
     b.iter(|| {
@@ -215,7 +215,7 @@ fn bench_quick_xml_one_comment_event_trimmed(b: &mut Bencher) {
 }
 
 #[bench]
-fn bench_quick_xml_one_cdata_event_trimmed(b: &mut Bencher) {
+fn bench_fast_xml_one_cdata_event_trimmed(b: &mut Bencher) {
     let src = format!(r#"<![CDATA[hello "{}"]]>"#, "world".repeat(512 / 5)).into_bytes();
     let mut buf = Vec::with_capacity(1024);
     b.iter(|| {

compare/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dev-dependencies]
-quick-xml = { path = "..", features = ["serialize"] }
+fast-xml = { path = "..", features = ["serialize"] }
 xml-rs = "0.8.0"
 serde-xml-rs = "0.4.1"
 serde = { version = "1.0.103", features = [ "derive" ] }

compare/benches/bench-serde.rs

@@ -1,6 +1,6 @@
 #![feature(test)]
 
-extern crate quick_xml;
+extern crate fast_xml;
 extern crate serde;
 extern crate serde_xml_rs;
 extern crate test;
@@ -40,9 +40,9 @@ struct Enclosure {
 }
 
 #[bench]
-fn bench_serde_quick_xml(b: &mut Bencher) {
+fn bench_serde_fast_xml(b: &mut Bencher) {
     b.iter(|| {
-        let rss: Rss = quick_xml::de::from_str(SOURCE).unwrap();
+        let rss: Rss = fast_xml::de::from_str(SOURCE).unwrap();
         assert_eq!(rss.channel.items.len(), 99);
     });
 }

compare/benches/bench.rs

@@ -1,15 +1,15 @@
 #![feature(test)]
 
-extern crate quick_xml;
+extern crate fast_xml;
 extern crate test;
 extern crate xml;
 
-use quick_xml::{events::Event, Reader};
+use fast_xml::{events::Event, Reader};
 use test::Bencher;
 use xml::reader::{EventReader, XmlEvent};
 
 #[bench]
-fn bench_quick_xml(b: &mut Bencher) {
+fn bench_fast_xml(b: &mut Bencher) {
     let src: &[u8] = include_bytes!("../../tests/sample_rss.xml");
     b.iter(|| {
         let mut r = Reader::from_reader(src);

examples/custom_entities.rs

@@ -7,11 +7,11 @@
 //! * the regex in this example is simple but brittle;
 //! * it does not support the use of entities in entity declaration.
 
-extern crate quick_xml;
+extern crate fast_xml;
 extern crate regex;
 
-use quick_xml::events::Event;
-use quick_xml::Reader;
+use fast_xml::events::Event;
+use fast_xml::Reader;
 use regex::bytes::Regex;
 use std::collections::HashMap;
 

examples/issue68.rs

@@ -1,9 +1,9 @@
 #![allow(unused)]
 
-extern crate quick_xml;
+extern crate fast_xml;
 
-use quick_xml::events::Event;
-use quick_xml::Reader;
+use fast_xml::events::Event;
+use fast_xml::Reader;
 use std::io::Read;
 
 struct Resource {

examples/nested_readers.rs

@@ -1,6 +1,6 @@
-extern crate quick_xml;
-use quick_xml::events::Event;
-use quick_xml::Reader;
+extern crate fast_xml;
+use fast_xml::events::Event;
+use fast_xml::Reader;
 // a structure to capture the rows we've extracted
 // from a ECMA-376 table in document.xml
 #[derive(Debug, Clone)]
@@ -11,7 +11,7 @@ struct TableStat {
 // demonstrate how to nest readers
 // This is useful for when you need to traverse
 // a few levels of a document to extract things.
-fn main() -> Result<(), quick_xml::Error> {
+fn main() -> Result<(), fast_xml::Error> {
     let mut buf = Vec::new();
     // buffer for nested reader
     let mut skip_buf = Vec::new();

examples/read_texts.rs

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

fuzz/Cargo.toml

@@ -1,14 +1,14 @@
 
 [package]
-name = "quick-xml-fuzz"
+name = "fast-xml-fuzz"
 version = "0.0.1"
 authors = ["Automatically generated"]
 publish = false
 
 [package.metadata]
 cargo-fuzz = true
 
-[dependencies.quick-xml]
+[dependencies.fast-xml]
 path = ".."
 [dependencies.libfuzzer-sys]
 git = "https://github.com/rust-fuzz/libfuzzer-sys.git"

fuzz/fuzz_targets/fuzz_target_1.rs

@@ -1,9 +1,9 @@
 #![no_main]
 #[macro_use] extern crate libfuzzer_sys;
-extern crate quick_xml;
+extern crate fast_xml;
 
-use quick_xml::Reader;
-use quick_xml::events::Event;
+use fast_xml::Reader;
+use fast_xml::events::Event;
 use std::io::Cursor;
 
 fuzz_target!(|data: &[u8]| {
@@ -24,7 +24,7 @@ fuzz_target!(|data: &[u8]| {
                 }
             }
             Ok(Event::Text(ref e)) | Ok(Event::Comment(ref e))
-            | Ok(Event::CData(ref e)) | Ok(Event::PI(ref e)) 
+            | Ok(Event::CData(ref e)) | Ok(Event::PI(ref e))
             | Ok(Event::DocType(ref e)) => {
                 if e.unescaped().is_err() {
                     break;