Merge #13: Include <string> tags for valid UTF-8 byte sequences

15e4584 docs: recover original header (magecnion)
0927211 docs: recover original header (magecnion)
838ffc0 docs: update README.md (magecnion)
9f38ef6 feat!: include <string> tag for valid utf8 byte sequences (magecnion)

Pull request description:

  - Introduce `<string>` tags around valid UTF-8 byte sequences in the output.
  - Update documentation to reflect these changes.
  - Modify the `bencoded_string_with_repeated_byte` function so it works with other lengths different from `1000000`.

ACKs for top commit:
  josecelano:
    ACK 15e4584

Tree-SHA512: cbe3e888d9fdca2ebfccd01ecbfb9c9bb6597fdfff2f6f84cbbfba599e1feb4203df14f609b192f05d7ea3776957817ad82399bef0fb99d76cadf8c88b3850d8

Author: josecelano

README.md

@@ -32,19 +32,19 @@ Run the binary with stdin and stdout (UTF-8):
 
 ```console
 echo "4:spam" | cargo run
-"spam"
+"<string>spam</string>"
 ```
 
 Run the binary with stdin and stdout (non UTF-8):
 
 ```console
 printf "d3:bar2:\xFF\xFEe" | cargo run
-{"bar":"<hex>fffe</hex>"}
+{"<string>bar</string>":"<hex>fffe</hex>"}
 ```
 
 ```console
 printf "d2:\xFF\xFE3:bare" | cargo run
-{"<hex>fffe</hex>":"bar"}
+{"<hex>fffe</hex>":"<string>bar</string>"}
 ```
 
 > NOTICE: We need two escape the two bytes `FF` and `FE` with `\x` inside the string.
@@ -53,7 +53,7 @@ More examples:
 
 ```console
 cat ./tests/fixtures/sample.bencode | cargo run
-["spam"]
+["<string>spam</string>"]
 ```
 
 More examples with invalid Bencode:
@@ -81,9 +81,9 @@ echo "d3:foold3:bari42eeee" | cargo run | jq
 
 ```json
 {
-  "foo": [
+  "<string>foo</string>": [
     {
-      "bar": 42
+      "<string>bar</string>": 42
     }
   ]
 }
@@ -121,7 +121,7 @@ use bencode2json::{try_bencode_to_json};
 
 let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();
 
-assert_eq!(result, r#"{"spam":"eggs"}"#);
+assert_eq!(result, r#"{"<string>spam</string>":"<string>eggs</<string>string>"}"#);
 ```
 
 Example using the low-level parser:
@@ -137,7 +137,7 @@ parser
   .write_str(&mut output)
   .expect("Bencode to JSON conversion failed");
 
-println!("{output}"); // It prints the JSON string: "spam"
+println!("{output}"); // It prints the JSON string: "<string>spam</string>"
 ```
 
 More [examples](./examples/).

examples/try_bencode_to_json.rs

@@ -8,5 +8,8 @@ use bencode2json::try_bencode_to_json;
 fn main() {
     let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();
 
-    assert_eq!(result, r#"{"spam":"eggs"}"#);
+    assert_eq!(
+        result,
+        r#"{"<string>spam</string>":"<string>eggs</string>"}"#
+    );
 }

src/lib.rs

@@ -22,7 +22,7 @@
 //!
 //! let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();
 //!
-//! assert_eq!(result, r#"{"spam":"eggs"}"#);
+//! assert_eq!(result, r#"{"<string>spam</string>":"<string>eggs</string>"}"#);
 //! ```
 //!
 //! The primary goal of this lib is to provide a simple and easy-to-use API for
@@ -73,7 +73,10 @@ mod tests {
         fn when_it_succeeds() {
             let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();
 
-            assert_eq!(result, r#"{"spam":"eggs"}"#);
+            assert_eq!(
+                result,
+                r#"{"<string>spam</string>":"<string>eggs</string>"}"#
+            );
         }
 
         #[test]